用途:agents-md 用于在用户要求创建、更新或维护 AGENTS.md(或设置 CLAUDE.md)时,生成面向 AI 编码智能体的项目文档。AGENTS.md 被视为面向代理的规范文档,强调保持精简,因为智能体本身具备能力,不需要过多引导。
主要能力与用法:在项目根目录创建 AGENTS.md,并建立符号链接:ln -s AGENTS.md CLAUDE.md。写作前可先发现本地技能以便引用:find .claude/skills -name "SKILL.md" 2>/dev/null 和 ls plugins//skills//SKILL.md 2>/dev/null,并阅读每个技能的 frontmatter 以判断何时引用。
写作规则:使用标题加项目符号,不用段落;命令和模板用代码块;引用而非复制,例如“Use db-migrate skill. See .claude/skills/db-migrate/SKILL.md”;不写填充内容,不要引言、结论或客套话;信任智能体能力,省略显而易见的内容。
必需章节:包管理器(只写工具和关键命令,如 Use pnpm: pnpm install、pnpm dev、pnpm test);提交归属(必须包含,AI 提交需带 Co-Authored-By,例如 Co-Authored-By: Claude Sonnet 4 noreply@example.com);关键约定(项目特定模式,保持简短);本地技能(逐个引用发现的技能,如数据库用 db-migrate、测试用 write-tests)。
可选章节:仅在确有必要时添加,如 API 路由模式(给模板而非解释)、CLI 命令(表格形式)、文件命名约定。
应避免:欢迎语或“本文档说明……”之类开场;“你应该……”或“记得……”;从技能复制的内容(应改为引用);显而易见的指令(如“运行测试”“写干净代码”);解释原因(只说明做什么);长篇散文段落。
限制:资料未提供该技能的安装方式、收费、平台支持或效果数据,暂未提供。