agents-md-generator

Generate and update AGENTS.md files documenting agent architecture and commands.

Updated Apr 10, 2026
One-click install
npx skills add https://github.com/yuridefranca/ai-prompts --skill agents-md-generator-yuridefranca
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: agents-md-generator
Source: https://github.com/yuridefranca/ai-prompts/tree/main/src/skills/agents-md-generator
Command: npx skills add https://github.com/yuridefranca/ai-prompts --skill agents-md-generator-yuridefranca

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Many projects with multiple AI orchestrator and specialist agents lack a single, up-to-date AGENTS.md that documents agents, their responsibilities, and how to use and test them; this skill streamlines creation and maintenance of that file so AI and humans can discover and rely on accurate agent documentation.

Core Features & Use Cases

  • Generate AGENTS.md: Create a comprehensive AGENTS.md that explains project purpose, architecture, agent roles, and workflows.
  • Update and validate: Detect outdated information, rename existing files to preserve history, and update content to reflect current technologies, dependencies, and commands.
  • Evals integration: Run evaluative checks to compare AGENTS.md content against the codebase and documentation to ensure accuracy and completeness.
  • Use case: Add a new orchestrator agent to the repo and run this skill to produce an AGENTS.md entry that lists responsibilities, build/test commands, and verification steps.

Quick Start

Create or update an AGENTS.md that documents all agents, their responsibilities, technologies, build and test commands, and run evals to validate accuracy.

Frequently Asked Questions about agents-md-generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate an AGENTS.md file for a project with multiple AI agents?

To generate an AGENTS.md file for AI agents, you need a tool that scans your codebase to document architecture, agent roles, technologies, and build commands. This skill automates that process to produce structured, discoverable agent documentation.

What is the best way to keep agent documentation current as my codebase changes?

Keeping agent documentation current requires detecting outdated information and updating content to reflect new technologies and dependencies. This skill renames existing files to preserve history while regenerating accurate AGENTS.md content for your agents.

Can I validate that my AGENTS.md accurately reflects my codebase and agent workflows?

You can validate AGENTS.md accuracy by running evaluative checks that compare the documentation against the codebase. This skill includes evals integration to verify completeness and ensure your agent behavior documentation matches reality.

Does generating agent documentation require specific project structures or dependencies?

Generating agent documentation applies to codebases that include orchestrator and specialist AI agents where onboarding and discoverability are required. This skill has no external dependencies and works within your existing project structure.

Why do I need a dedicated AGENTS.md file instead of standard project documentation?

A dedicated AGENTS.md file is needed when multiple AI orchestrator and specialist agents lack a single source of truth for responsibilities and testing. Standard documentation often misses specific build commands and verification steps required for agent validation.