agents-md-generator

AGENTS.md 生成器是一款专为 AI 辅助开发设计的关键工程工具，旨在为代码库知识建立结构。通过创建轻量级的分层文档系统，它确保编码代理在不会耗尽 token 窗口的情况下获得最相关的上下文。此工具针对需要建立 AI 友好项目文档的技术负责人与开发人员，遵循「最近优先」层级原则，确保代理始终能够访问最相关的项目规范、设计模式与即时索引指令。

• 自动分析代码库结构，识别 Monorepo 工作区、技术堆栈与关键目录。

• 生成根目录 AGENTS.md 文件，重点包含通用规范、安全性协议与高阶项目快照。

• 产出针对子目录的 AGENTS.md 文件，包含细粒度的模式、命名惯例与「执行/避免」(DO/DON'T) 代码示例。

• 实现即时索引功能，利用 ripgrep 与 find 等指令工具引导代理查找代码，无需嵌入完整源代码文件。

• 支持设计系统、后端 API 服务、数据库层与测试套件的专门模板。

• 输入：用户的触发词，如「create AGENTS.md」、「generate agents」或「AI documentation setup」。

• 输出：包含摘要分析、轻量级根目录配置以及详细模块级别文档的结构化 Markdown 层级。

• 最佳实践：将根目录文件保持在 200 行以内以维护 token 效率。务必将子文件链接至根目录，并使用绝对路径示例说明代码模式。

• 限制：此工具针对结构化项目树（如 Turborepo, pnpm workspaces）进行了优化。请确保「Pre-PR」指令区块保持为可单击复制的 Shell 指令，以实现最高操作速度。

• 适用场景：为现有仓库导入新的 AI 编码代理、在团队环境中强制执行严格的架构模式，并通过提供扎实的指令式文档来减少幻觉。