agent-readme

agent-readme is a skill for Claude Code from elie222/atom-eve. It costs 83 tokens per session (1,640 once invoked), scanned A, original, MIT.

A writing guide for creating or shortening the README file that explains what a registry agent does for people deciding whether to install it.

In plain words
What is it for?
It helps write a fixed README structure with a short description, category, integrations, and a concise explanation of the agent’s actions and results.
Why use it?
It prevents agent READMEs from repeating catalog information or mixing the explanation with setup instructions and internal prompts.

Skill for Claude Code

Written for Claude Code: installed under .claude/. Also seen: mentions AGENTS.md.

Good fit It helps write a fixed README structure with a short description, category, integrations, and a concise explanation of the agent’s actions and results.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/elie222/atom-eve/agent-readme
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add elie222/atom-eve --skill agent-readme
Clone the repo
git clone --depth 1 https://github.com/elie222/atom-eve

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for agent-readme

README.md
[![agentmods](https://agentmods.dev/badge/skills/elie222/atom-eve/agent-readme/github.svg)](https://agentmods.dev/skills/elie222/atom-eve/agent-readme)
Your own site
<a href="https://agentmods.dev/skills/elie222/atom-eve/agent-readme"><img src="https://agentmods.dev/badge/skills/elie222/atom-eve/agent-readme/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for agent-readme

Your own site · 80×15
<a href="https://agentmods.dev/skills/elie222/atom-eve/agent-readme"><img src="https://agentmods.dev/badge/skills/elie222/atom-eve/agent-readme.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 83 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,640 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00083 $0.01640
Opus 5 $0.00042 $0.00820
Sonnet 5 $0.00017 $0.00328
Haiku 4.5 $0.00008 $0.00164

Measured 9d ago against content hash c45df26e195d, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

agent-readme scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 9d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.claude/skills/agent-readme/SKILL.md · 112 lines

How it starts

The opening of the file, as written. The whole thing — 112 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Agent READMEs

A README is the human's install decision: what this agent does for me. It is not the agent's prompt (instructions.md, addressed to the agent), and it is not the setup guide (SETUP.md, which owns env, config, and the wiring walkthrough). It carries only what is unique to this agent. Everything derivable the catalog page already renders, so repeating it is the slop to cut.

The shape

The README is the manifest in YAML frontmatter, an H1, and exactly one section. No lead paragraph, and never a ## Setup section: the build rejects one.

---
description: <one outcome-led sentence; the catalog card>
category: <an id from taxonomy.json>
integrations: [<display tags>]
---

# <Title>

## What it does

<lead line: the outcome the agent delivers. Then the concrete actions as short bullets, and what you get back.>

Frontmatter fields: description, category, integrations, and optionally author, dependencies (npm packages the agent needs), and skills (remote skill refs). Everything else is derived by the build, never authored: name (the directory), title (the H1), family (taxonomy via category), connections (from agent/connections/*.ts).

The build requires the H1, ## What it does, and a valid category. The one-line description is what the catalog page renders at the top, and it feeds cards and SEO; write it outcome-led, not led by the mechanism, framework, or backend. Don't append "Agent" to the H1 unless it is part of a proper name.

Setup never lives here. Credentials, config, and the wiring walkthrough belong in SETUP.md (its frontmatter declares env and config; its body is the walkthrough). The README may close "What it does" with a single pointer line, Setup lives in [SETUP.md](./SETUP.md)., and nothing more.

For an external template, the README is the whole entry: frontmatter with a source: block (type: external-template, repo, url, cloneUrl) plus the H1 and ## What it does. No SETUP.md, no agent/. Do not summarize the upstream setup, credentials, or runtime steps; the external repo owns those details.

Read the full file on GitHub · 112 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 9d ago First seen · 112 lines · 83 tokens per session scan A c45df26e195d

Subscribe to this mod's changes

agent-readme is a skill published in the GitHub repository elie222/atom-eve (49 stars, last pushed 2mo ago), licensed MIT. It adds 83 tokens to every session and 1,640 once invoked, about $0.0004 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

seo-audit

How to present the deterministic AI-SEO audit returned by auditpage. Use when reporting a page's readability and citation-readiness for AI answer engines (ChatGPT, Claude, Perplexity).

shadcn-labs/agentcn · 43 tokens

workspace

How to safely operate the sandboxed workspace. Use for any multi-step task involving files or shell commands.

shadcn-labs/agentcn · 23 tokens

research

Iterative, self-evaluating web research. Use when answering open-ended questions that require gathering and verifying information from multiple sources.

shadcn-labs/agentcn · 28 tokens

writing-quality

Writing-quality guardrails for any prose the agent drafts or edits: blog posts, page copy, Notion drafts, release notes, marketing text. Use this skill whenever writing or revising content meant for humans to read, to keep the prose natural, plain, and free of AI-sounding phrasing. Not needed for code, queries, or…

vercel-labs/sanity-copilot-eve-template · 73 tokens

sanity-best-practices

Sanity development best practices for schema design, GROQ queries, TypeGen, Visual Editing, images, Portable Text, Studio structure, localization, migrations, Sanity Functions, Blueprints, and framework integrations such as Next.js, Nuxt, Astro, Remix, SvelteKit, Angular, Hydrogen, and the App SDK. Use this skill…

vercel-labs/sanity-copilot-eve-template · 153 tokens

portable-text-serialization

Render and serialize Portable Text to React, Svelte, Vue, Astro, HTML, Markdown, and plain text. Use when implementing Portable Text rendering in any frontend framework, building custom serializers for non-standard block types, converting Portable Text to HTML strings server-side, converting Portable Text to Markdown…

vercel-labs/sanity-copilot-eve-template · 80 tokens