AGENTS.md 是一种开放的 Markdown 格式,用于为编码代理提供项目专属说明,包括环境搭建命令、测试步骤、编码规范和仓库指引。它就像是给 AI 代理看的 README,能帮助它们在不同仓库和工具中更高效地工作。
适合人群
- 开源维护者
- 软件工程师
- 技术负责人
- 单体仓库维护者
- DevOps 工程师
- 平台工程师
- AI 编码代理用户
- QA 工程师
产品优势
- 清晰且可预测的代理说明位置
- 简单的 Markdown 格式,易于编辑
- 可跨多种编码代理和开发工具使用
- 支持嵌套文件,便于分范围配置
- 保持 README 文件更简洁,更聚焦人类读者
使用注意
- 需要手动维护,才能保持最新
- 依赖书面说明的质量和完整性
- 本身不会自动强制执行规则
- 如果组织不当,可能与现有文档内容重叠





