用途:为代码库创建分层 AGENTS.md 体系,使 AI 编码代理以最小 token 消耗高效工作。根文件保持轻量(约100-200行),仅放通用指引,作为索引与导航中心;子目录文件提供更详细、技术相关的约定。代理读取距离被编辑文件最近的 AGENTS.md,子文件覆盖根文件(就近优先)。
主要能力:按阶段生成文档。阶段1分析仓库类型(monorepo、多包、简单项目)、技术栈、主要目录、构建与测试设置、关键模式与反模式,输出结构化仓库地图。阶段2生成根 AGENTS.md,包含项目快照、根安装/构建/类型检查/测试命令、通用约定(代码风格、提交格式、分支策略、PR要求)、实现规则、开发工作流、安全与密钥、JIT 索引目录映射、验收标准。阶段3为每个主要包/目录生成子 AGENTS.md,含包身份、安装运行、模式与约定(最重要,需含真实文件路径的 DO/DON'T 示例)、关键文件、JIT 索引提示、常见陷阱、PR 前检查。阶段4针对设计系统、数据库、API、测试等类型适配模板。
使用方式:按阶段顺序执行,完整细节见 references/generation-process.md。JIT 索引以路径引用文件而非粘贴内容,并提供可执行搜索命令,例如 rg -n "functionName" apps/** packages/**。实现规则要求添加任何外部依赖前用 WebSearch 核实最新稳定版本,不信任训练数据中的版本号。
适用场景:为新项目创建 AGENTS.md、为 monorepo 设置代理指引、优化现有文档的 token 效率、实现 JIT 索引模式。
限制:根文件应低于200行,根与子文件不得重复,所有路径须为相对路径并确认存在,仅主要包/域设 AGENTS.md 而非每个目录。新增包、变更构建/测试命令、建立新约定或重构结构时需更新文档。资料未提供具体收费、平台与效果信息。