| name | agents-md-generator |
| domain | agent-tools |
| skill_type | skill |
| description | Generate or update a robust AGENTS.md file (the "README for AI coding agents") for a project. This skill ensures your repository is optimized for AI tools (like Copilot, Cursor, and Windsurf) by providing structured context, commands, architecture diagrams, and coding standards. It automatically detects project metadata from pyproject.toml and generates a project tree view. |
| license | MIT |
| tags | ["agent","agents.md","documentation","ai-optimization","mcp","architecture"] |
| metadata | {"version":"1.2.1","author":"Genius"} |
AGENTS.md Generator
Generates a robust AGENTS.md file designed specifically for AI coding agents. This file acts as a "README for machines," providing them with the exact project context, rules, and instructions they need to work effectively.
Features
- Project Metadata Extraction: Automatically parses
pyproject.toml for project name, description, and scripts.
- Dynamic File Tree: Generates a text-based tree view of the project structure, ignoring common noise directories (
.git, __pycache__, etc.).
- Mermaid Diagrams: Includes standardized Architecture and Workflow diagrams to help agents understand the system's design.
- Battle-Tested Template: Uses a structure optimized for high agent performance, including "Always/Ask first/Never" boundaries.
Usage
Run the generator script with the path to your project root:
python scripts/generate_agents_md.py <project-path>
Options
<project-path>: (Required) Path to the root directory of the project to document.
AGENTS.md Standard
The generated AGENTS.md follows the emerging open standard for AI agent documentation:
- Tech Stack & Architecture: High-level overview of technologies and component interactions.
- Commands: Exact, file-scoped commands for building, testing, and linting.
- Project Structure: Quick reference to key files and the dynamic tree view.
- Code Style & Conventions: Specific "Always" rules with concrete Good/Bad code examples.
- Dos and Don'ts: Specific behavioral guidelines.
- Safety & Boundaries: Explicit "Always do", "Ask first", and "Never do" constraints.
- When Stuck: Instructions on how to handle ambiguity (e.g., "propose a plan first").
