用途:为代码库生成分层 AGENTS.md 文档,供 AI 编码代理读取,以最小 token 占用提供就近、可执行的指引。
主要能力:按四阶段工作流生成文档。第一阶段分析仓库类型(monorepo、多包或简单项目)、技术栈、需要独立 AGENTS.md 的主要目录(apps、services、packages、workers)、构建系统(pnpm/npm/yarn workspaces、Turborepo、Lerna)、测试框架与关键模式,并以结构化地图呈现。第二阶段生成轻量根 AGENTS.md(约 100-200 行),含项目快照、根级安装/构建/类型检查/测试命令、通用约定、安全与密钥、JIT 索引和完成定义。第三阶段为每个主要包生成更详细的子目录 AGENTS.md,含包身份、运行命令、模式与约定(含真实文件路径的 DO/DON'T 示例)、关键文件、JIT 搜索提示、常见陷阱与 PR 前检查。第四阶段提供设计系统/UI、数据库/数据层、API/后端、测试等专项模板。
核心原则:根文件轻量、就近优先层级、JIT 索引只给路径/glob/命令而非全文、子文件更详细、token 高效。
使用方式:当用户要求创建 AGENTS.md、分析代码库以生成 AI 代理文档或搭建相关结构时使用。输出按顺序给出分析摘要、根 AGENTS.md、各子目录 AGENTS.md 及文件路径。
限制:资料未提供安装命令、收费方式、支持平台或实际效果数据;生成质量依赖对仓库的实际分析,命令需按项目实际情况调整。