协议与标准
AGENTS.md
AGENTS.md 是放在项目仓库里的一个纯文本文件,用来给 AI 编程 Agent 提供项目特定的说明,比如怎么安装、构建、测试,以及要遵守哪些约定。
编程 Agent 在处理一个仓库时,往往需要一些人类贡献者通常会从 README、CONTRIBUTING 文档、或者团队里口口相传得到的信息——怎么装依赖、跑测试用哪条命令、项目对代码风格有什么要求。AGENTS.md 是一种约定,把这些信息放在一个固定、可预期的位置,让 Agent 不用每次都被人重新告知一遍。
它是一个纯文本(通常是 Markdown)文件,被多种不同的编程 Agent 读取,而不是绑定某一家厂商的私有格式。项目维护者只需要写一次,之后任何认识 AGENTS.md 这个约定的 Agent 在处理这个仓库时都会自动读取它,就像很多工具本来就会按约定去找 README.md 一样。
AGENTS.md 是一种约定,不是强制标准——没有哪个规则要求项目必须有这个文件,如果某个 Agent 不认识这个文件,它就单纯不会用上它。真正加了这个文件的项目,内容通常都比较聚焦:安装和运行命令、测试方法,以及这个代码库特有的、真正重要的代码风格或工作流规则。
举个例子
# AGENTS.md
## 安装
运行 `npm install` 安装依赖。
## 测试
提交前运行 `npm test`,所有测试必须通过。
## 代码风格
使用 2 空格缩进,优先使用具名导出而非默认导出。常见误解
常被以为: 编程 Agent 处理仓库必须要有 AGENTS.md 才能工作。
实际上: 这是可选的——没有这个文件时,Agent 只是退回到自己探索代码库、或者参考其他现有文档;有了 AGENTS.md 只是让这一步更快、更可靠。
常被以为: AGENTS.md 是某一家编程 Agent 厂商专属的格式。
实际上: 它本来就是设计给多种不同编程 Agent 读取的、与具体工具无关的共享约定,性质上和很多工具都认 README.md 这个约定差不多。
常见问题
AGENTS.md 里一般写什么?
通常是安装/构建命令、怎么跑测试,以及这个项目特有的代码约定或工作流说明,让 Agent 照着来做。
一定要写 AGENTS.md 吗?
不是必须的——但如果你的编程 Agent 老是猜错怎么构建或测试你的项目,加一个通常就能解决。
AGENTS.md 和 SKILL.md 是一回事吗?
不是——AGENTS.md 是给某个具体仓库的项目特定说明;SKILL.md 打包的是一种可复用的能力,带有自己的触发条件,不依赖某一个具体项目。
最近核实: 2026-08-28