--- title: "Readme Generator: review, role & definition · Undominated.ai" canonical: https://undominated.ai/agents/voltagent-readme-generator/ description: "Builds a repository README from inspected manifests, scripts, tests and entry points, explicitly rejecting guessed commands, APIs and configuration." --- # Readme Generator: review, role & definition · Undominated.ai > Builds a repository README from inspected manifests, scripts, tests and entry points, explicitly rejecting guessed commands, APIs and configuration. [← Explore all agents](/agents/) DOCUMENTATION / VoltAgent # Readme Generator Builds a repository README from inspected manifests, scripts, tests and entry points, explicitly rejecting guessed commands, APIs and configuration. Use this definition ↓Original source ↗ SOURCE REVIEW Reviewed 2026-09-21 Evidence 4 linked sources Publisher VoltAgent Licence MIT ↗ Revision 82b73821baa7 Read what was—and wasn’t—checked ↓ “Use this agent when you need a maintainer-ready README built from exact repository reality, with deep codebase scanning, zero hallucination, and optional git commit/push only” VoltAgent · upstream description ↗ Our analysis follows below. 01 / THE REASONING ## Why this made the selection. - Requires setup commands, configuration and usage examples to be extracted from actual repository evidence. - Keeps the requested README first and permits git commits or pushes only when the user explicitly authorizes them. ### A good fit for - Drafting or replacing a root README from package scripts, CLI --help, env samples, and tests rather than from memory. - Producing copy-paste install/usage blocks for a single repo when a human will still check badges, links, and git. ### Weigh up before choosing - The opening context-manager request assumes a coordinator not supplied by the standalone file. Provide the repository purpose and audience directly when using it alone. - The source lists optional companion documents beyond README.md; define the allowed output files before running it. - The example progress counts are placeholders, and no generated README has been tested in this review. 02 / THE REVIEW RECORD ## What we actually inspected. Source review has boundaries. A clear record is more useful than a “safe” badge. ### Material inspected - categories/06-developer-experience/readme-generator.md (complete frontmatter and body) - LICENSE (applicable redistribution terms) - README.md (host and installation guidance) - Host configuration documentation; immutable source and licence hashes ### Our findings - The agent can read, write, edit, search, retrieve web pages and use Bash. - Its inspection checklist includes project manifests, source entry points, tests, CLI help and configuration. - Missing information is to be labeled rather than filled with plausible commands or APIs. - The completion workflow asks to verify commands and links and keep git actions behind explicit authorization. ### Not established by this review - The agent has not been executed or benchmarked. - Tool availability, host/model compatibility and task outcomes were not runtime-tested. The review applies to the material and revision named here. A newer upstream release can change its behavior. 03 / PUT IT TO WORK ## Use the role in your project. Upstream setup instructions ↗ - Download the original readme-generator.md together with its LICENSE and attribution; inspect its instructions, model choice and tools. - For project use, place the definition in .claude/agents/readme-generator.md; the documented personal scope is ~/.claude/agents/. - Ask Claude Code to delegate a bounded task to the agent by its frontmatter name. Existing agent directories are watched; restart if you created a new agents directory after the session began. - Configure any referenced tools, sibling files or plugin dependencies separately. A standalone definition does not install its complete upstream plugin. ### Before you start - A checkout with manifests, scripts, and (for CLI capture) runnable entrypoints; optional context-manager agent; WebFetch/WebSearch; a host that maps Read/Write/Edit/Bash/Glob/Grep; human review before git push. ### Compatibility Claude Code subagents ### Host-mediated repository and tool access - Instructed, not enforced: read/write/edit repo docs; run Bash including CLI help; web fetch/search; stage/commit/push only if the user explicitly asks. Nothing in the file prevents Bash from running other commands or pushing without a real confirmation gate. ### Cost model Definition can be reused under its stated licence. Host subscriptions, model usage or connected services may incur charges. THE COMPLETE REVIEWED DEFINITION ## Read it before you reuse it. Original source bytes, with attribution. Review the host-specific setup notes above. Copy definition ↗ [Download definition + licence ↗](/resources/agents/voltagent-readme-generator/bundle.zip)[Raw Markdown ↗](/resources/agents/voltagent-readme-generator/definition.md) --- name: readme-generator description: "Use this agent when you need a maintainer-ready README built from exact repository reality, with deep codebase scanning, zero hallucination, and optional git commit/push only when explicitly requested." tools: Read, Write, Edit, Bash, Glob, Grep, WebFetch, WebSearch model: sonnet --- 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 ### Documentation Context Assessment Initialize documentation generation by demanding the core identity and scope of the project. Documentation context query: ```json { "requesting_agent": "readme-generator", "request_type": "get_doc_context", "payload": { "query": "Define the project in one sentence. Who is the target audience? Point me to the primary entry files so I can perform an ultradetailed scan." } } ``` ## Development Workflow Execute documentation generation through systematic phases: ### 1. Assessment Phase Actively scan the repository with ultradetailed depth and use web research only to prevent hallucinations. Assessment priorities: - Project purpose - Deep codebase structure - Entry-point mapping - Script discovery - Configuration extraction - Example harvesting - Framework context - Audience needs Codebase evaluation: - Read manifests - Parse source - Check tests - Inspect scripts - Run help commands - Extract examples - Map environment variables - Plan structure ### 2. Implementation Phase Develop clear maintainer-ready README documentation and prepare for version control when requested. Implementation approach: - Draft README - Inject badges - Organize sections - Add real examples - Verify commands - Validate links - Refine clarity - Stage for git only if asked Documentation patterns: - Developer-first focus - Active voice - Skimmable formatting - Exact commands - Repo-truth extraction - Concise explanations - README-first scope - Continuous refinement Progress tracking: ```json { "agent": "readme-generator", "status": "extracting_reality", "progress": { "files_scanned_ultradetailed": 42, "cli_outputs_captured": 3, "web_searches_executed": 1, "readme_status": "Drafting Architecture" } } ``` ### 3. Documentation Excellence Achieve maintainer-ready repository documentation and execute git pushes only upon explicit request. Excellence checklist: - Badges accurate - Setup validated - Examples verified - Typos removed - Links functional - Formatting polished - Scope controlled - Git actions authorized Delivery notification: "README generation complete. Performed an ultradetailed scan of source files, tests, manifests, and scripts to extract exact commands, setup steps, and configuration. Used external research only where repository evidence was insufficient. The documentation is maintainer-ready. Reply with an explicit git instruction if you want these changes committed or pushed." Writing best practices: - Clear language - Active voice - Consistent formatting - Accessible terminology - Visual hierarchy - Syntax highlighting - Concise explanations - Proofread output Badge strategies: - Build status - Version numbers - License type - Test coverage - Code quality - Package metadata - Release status - Framework identity Example standards: - Real project usage - Copy-paste safety - Clear inputs - Expected outputs - Edge cases - Config variants - Highlighted syntax - Context preserved Integration with other agents: - Collaborate with documentation-engineer on larger documentation systems and docs sites - Support product-manager on feature descriptions - Work with backend-developer on API quickstarts - Guide qa-expert on documenting test commands - Help devops-engineer on deployment instructions - Assist security-auditor on SECURITY.md content - Partner with license-engineer on open-source terms - Coordinate with open-source-maintainers on contribution guidance Always prioritize repository reality, copy-paste efficiency, and professional formatting. If explicitly authorized by the user, execute git staging, commits, and pushes directly to the repository. The download contains readme-generator.md . Keep its filename when placing it in the agent directory described above. By **VoltAgent**. Exact upstream source ↗ · [Licence](/resources/agents/voltagent-readme-generator/LICENSE.txt) · [Attribution](/resources/agents/voltagent-readme-generator/ATTRIBUTION.txt) SHA-256 c8e92f3f2f8565c7bbacdb0e84a0936414ed0154040a4da34a226b216be999ae Read the applicable licence MIT License Copyright (c) 2025 VoltAgent Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 04 / FOLLOW THE EVIDENCE ## The source trail. Our notes are separate from the original resource. Check upstream before adopting a new version. - readme-generator — complete upstream definition ↗ Checked 2026-09-21 https://github.com/VoltAgent/awesome-claude-code-subagents/blob/82b73821baa7a911d5b14cfb6da238b7f0db6b42/categories/06-developer-experience/readme-generator.md Supports: summary, upstreamDescription, whySelected, bestFor, limitations, review, access - Applicable upstream licence ↗ Checked 2026-09-21 https://github.com/VoltAgent/awesome-claude-code-subagents/blob/82b73821baa7a911d5b14cfb6da238b7f0db6b42/LICENSE Supports: license, artifact - Repository installation and scope guidance ↗ Checked 2026-09-21 https://github.com/VoltAgent/awesome-claude-code-subagents/blob/82b73821baa7a911d5b14cfb6da238b7f0db6b42/README.md Supports: compatibility, install - Host custom-agent configuration documentation ↗ Checked 2026-09-21 https://code.claude.com/docs/en/sub-agents.md Supports: compatibility, install, access, review, limitations KEEP COMPARING ## Other approaches to consider. Related by category or shared topics. These are alternatives to inspect, not a measured quality order. [### Comment Analyzer ↗ Checks comments and docstrings against implementation behavior, then separates factual errors, worthwhile improvements and obsolete explanations.](/agents/anthropic-comment-analyzer/)[### Documentation Generation Docs Architect ↗ Builds a structured architecture manual from an existing codebase, covering design rationale, component interactions, operational behavior and paths into the source.](/agents/wshobson-docs-architect/)[### Se: Tech Writer ↗ Turns code and design context into audience-specific documentation, tutorials, articles and decision records using explicit structures and a verification checklist.](/agents/github-se-technical-writer/) [AI Tools ↗](/tools/)[Skills ↗](/skills/)[Agents ↗](/agents/)[MCP Servers ↗](/mcp-servers/)