agents-md-generator

An AGENTS.md file provides concise guidance for navigating a repository, covering its purpose, tooling, and canonical commands. It helps readers and automated agents understand project structure and module-specific instructions using progressive disclosure.

To generate AGENTS.md files for a monorepo, create a root file describing repository purpose and tooling, then add nested AGENTS.md files in module directories with local commands and references. This maintains consistent guidance as the repository structure evolves.

Progressive disclosure keeps repository documentation concise by placing high-level guidance in the root AGENTS.md and deferring module-specific commands to nested AGENTS.md files. Readers navigate to modules only when they need those specific instructions.

Yes, you can update AGENTS.md files as your repository structure changes. Refreshing the root and nested module files ensures documentation stays consistent with current tooling, commands, and module references across the project.

The best way to document module-specific commands is creating nested AGENTS.md files within each module directory. This approach separates local commands from root-level tooling guidance, keeping navigation clear for multi-package projects.

Nested AGENTS.md files are unnecessary for single-package repositories without distinct modules. If your project lacks complex tooling or separate module directories, a single root AGENTS.md file is sufficient to guide readers.