用途:为代码仓库生成一份专属的 AGENTS.md,向 AI 智能体提供在该仓库中有效工作所需的上下文。每个章节都应引用仓库中真实的命令、路径和约定,而不是通用建议。
主要能力:先检查仓库根目录是否已有 AGENTS.md(或 .agents/AGENTS.md)。若已存在,不从头重写,而是读取仓库、与现有文档对比,提出具体增改建议交由用户决定;若不存在则新建。读取来源包括:命令(Makefile/justfile/Taskfile.yml、package.json scripts、pyproject.toml、.github/workflows/*.yml、Cargo.toml、build.gradle/pom.xml、Rakefile、docker-compose.yml);项目结构(顶层目录、monorepo 标识、源码与测试布局);约定(linter/formatter 配置、CONTRIBUTING.md、README、.editorconfig);护栏(数据库配置、CI 强制项、密钥/环境变量模式、分支保护)。
使用方式:按步骤执行——Step 0 检查现有文件,Step 1 读取仓库,Step 2 按结构撰写 AGENTS.md。建议结构含项目概览、命令(构建/测试/lint 与格式化)、项目结构、编码规范、测试、护栏等章节,均为可选,只保留与仓库相关的内容。
适用场景:需要让 AI 智能体在特定仓库中正确构建、测试、遵循约定并避开危险操作时。
限制与原则:命令须从仓库真实来源复制,不可臆造;要具体而非通用;链接而非重复已有文档;明确列出危险操作;保持简短可维护。应省略通用工程建议、属于 CONTRIBUTING.md 的流程文档、完整 API 文档和运维手册。monorepo 中根 AGENTS.md 覆盖仓库级命令与约定,仅对命令或约定差异较大的子包考虑单独文件并从根链接。具体安装命令与收费信息暂未提供。