agents-md-generator

Generate and update AGENTS.md files for repositories and modules.

104|17|Updated Jan 12, 2026
One-click install
npx skills add https://github.com/MADTeacher/mad-agents-skills --skill agents-md-generator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: agents-md-generator
Source: https://github.com/MADTeacher/mad-agents-skills/tree/main/agents-md-generator
Command: npx skills add https://github.com/MADTeacher/mad-agents-skills --skill agents-md-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation and upkeep of AGENTS.md files at the repository root and within modules, ensuring consistent agent context and navigability across diverse projects.

Core Features & Use Cases

  • Root AGENTS.md generation: documents repository purpose, tooling, canonical commands, and links to docs.
  • Nested AGENTS.md: each module/package gets its own concise guide with module purpose and local commands.
  • Progressive disclosure: directs readers to deeper docs for architecture, style guidelines, and CI details.

Quick Start

Run the agents-md-generator at the repository root to generate or update AGENTS.md files. If modules exist, run inside module directories to create nested AGENTS.md entries, then review the top-level AGENTS.md for structure.

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 AGENTS.md files for my repository automatically?

Generate AGENTS.md files automatically by running the generator at the repository root. It detects repository structure and produces concise documentation covering repository purpose, tooling, and canonical commands.

How does AGENTS.md generation work for monorepos with multiple modules?

AGENTS.md generation for monorepos detects individual modules and creates nested entries. Each module receives its own concise AGENTS.md guide with local purpose and commands, while the root file links to all nested documentation.

What is the best way to keep AGENTS.md files synchronized across multiple repositories?

Keep AGENTS.md files synchronized by running deterministic workflows that update repository and module entries. This standardizes agent context and ensures navigability across diverse projects without manual file editing.

Can I use AGENTS.md to provide progressive disclosure for deeper documentation?

AGENTS.md supports progressive disclosure by directing readers to deeper documentation for architecture, style guidelines, and CI details. The generated files link directly to these external docs for extended context.

Does AGENTS.md generation require any dependencies or external components?

AGENTS.md generation requires no dependencies or external components. It relies entirely on deterministic workflows and repository structure detection to produce navigable documentation.

When do I need to create nested AGENTS.md files instead of a single root file?

Create nested AGENTS.md files when your repository contains multiple modules or packages. Run the generator inside module directories to create nested entries, then review the top-level file for overall structure.