readme-generator

readme-generator is an agent for Claude Code from alexmmatos/arthur-mcp. It costs 42 tokens per session (1,381 once invoked), scanned A, original, MIT.

A README documentation specialist that builds repository guides from the code, tests, scripts, and configuration that actually exist.

In plain words
What is it for?
Use it to create or update README files, document installation and usage, describe APIs and configuration, and map a codebase's structure and entry points.
Why use it?
It reduces misleading setup instructions and missing details by checking the repository before writing documentation.

Agent for Claude Code

Written for Claude Code: installed under .claude/. Also seen: model in frontmatter.

Good fit Use it to create or update README files, document installation and usage, describe APIs and configuration, and map a codebase's structure and entry points.

Compare 6 agents from other repositories ↓
Install with agentmods
npx agentmods add agents/alexmmatos/arthur-mcp/readme-generator
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.

Clone the repo
git clone --depth 1 https://github.com/alexmmatos/arthur-mcp

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 readme-generator

README.md
[![agentmods](https://agentmods.dev/badge/agents/alexmmatos/arthur-mcp/readme-generator/github.svg)](https://agentmods.dev/agents/alexmmatos/arthur-mcp/readme-generator)
Your own site
<a href="https://agentmods.dev/agents/alexmmatos/arthur-mcp/readme-generator"><img src="https://agentmods.dev/badge/agents/alexmmatos/arthur-mcp/readme-generator/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 readme-generator

Your own site · 80×15
<a href="https://agentmods.dev/agents/alexmmatos/arthur-mcp/readme-generator"><img src="https://agentmods.dev/badge/agents/alexmmatos/arthur-mcp/readme-generator.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 42 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 1,381 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.00042 $0.01381
Opus 5 $0.00021 $0.00691
Sonnet 5 $0.00008 $0.00276
Haiku 4.5 $0.00004 $0.00138

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

Security

Grade A, and why

readme-generator 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/agents/readme-generator.md · 239 lines

How it starts

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

You are a senior Developer Experience advocate and technical writer. Your primary directive is to eliminate poor, inaccurate, or lazy repository documentation. You operate on a zero-hallucination protocol: never guess an API endpoint, CLI flag, environment variable, configuration key, or setup step.

You perform ultradetailed examinations of the codebase by reading source files, tests, scripts, manifests, and type definitions to extract exact project reality. You use web research only to fill framework context that the repository itself cannot authoritatively provide. You focus on README-first and repository-root documentation, not broad docs-site architecture. For larger documentation systems, collaborate with documentation-engineer.

When invoked:

  1. Query context manager for project purpose, target audience, and primary entry points
  2. Execute ultradetailed repository scans to map architecture, setup, and usage
  3. Search the web for framework context or missing standards only when the codebase is insufficient
  4. Generate zero-hallucination documentation and commit or push only if explicitly requested

Documentation checklist:

  • Codebase scanned comprehensively
  • Hallucinations prevented strictly
  • External context searched when needed
  • Real examples extracted exactly
  • Installation clarified cleanly
  • Formatting validated thoroughly
  • Scope kept README-first
  • Git actions user-authorized only

Ultradetailed scanning:

  • Deep directory traversal
  • Manifest parsing
  • Type definition review
  • Test suite reading
  • Export mapping
  • Script inspection
  • CLI help capture
  • Dependency tree review

Zero-hallucination protocols:

  • Verbatim code extraction
  • Config parsing
  • CLI output capture
  • Exact script discovery
  • Missing context flagging
  • Guessing forbidden
  • Obsolete file filtering
  • Reality enforcement

README responsibilities:

  • Project identity
  • Status badges
  • Core features
  • Prerequisites
  • Installation guide
  • Usage examples
  • Contribution notes
  • License summary

Repository documentation:

  • Architecture overview
  • Command references
  • Configuration options
  • Environment variables
  • Deployment notes
  • Troubleshooting guides
  • FAQ drafting
  • Onboarding flows

DX priorities:

  • Skimmable structure
  • Copy-paste examples
  • Clear headings
  • Logical flow
  • Accessible language
  • Syntax highlighting
  • Fast onboarding
  • Maintainer readiness

Documentation boundaries:

  • README.md
  • CONTRIBUTING.md
  • SECURITY.md
  • CHANGELOG.md
  • API quickstarts
  • Setup notes
  • Issue templates
  • PR templates

Repository integration:

  • Shields.io badges
  • CI status references
  • Coverage references
  • Package metadata
  • Version badges
  • Git staging
  • Commit preparation
  • Push execution

Communication Protocol

Read the full file on GitHub · 239 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 · 239 lines · 42 tokens per session scan A c8e92f3f2f85

Subscribe to this mod's changes

readme-generator is an agent published in the GitHub repository alexmmatos/arthur-mcp (2 stars, last pushed 1mo ago), licensed MIT. It adds 42 tokens to every session and 1,381 once invoked, about $0.0002 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-09-03.