刷 GitHub 的时候,你可能注意到越来越多项目根目录里躺着一个 AGENTS.md 文件。它跟 README 并排站着,但不是给人看的。
官方一句话:"README 是给人看的,AGENTS.md 是给 AI 看的。"
这个由 Linux 基金会旗下 Agentic AI Foundation 管理的开放标准,目前已经被 6 万多个开源项目采用,OpenAI Codex、GitHub Copilot、Cursor、Claude Code、Gemini 等 60 多款 AI 编码工具都能自动读取它。它正在悄悄成为"AI 编程时代"的项目配置标准。
它解决什么痛点:AI 不知道你的项目规矩
你用 AI 写代码,最烦的是什么?
- 它不知道你的测试命令是
pnpm test还是npm run test:ci,瞎猜 - 它不知道你的代码规范——用 ES Module 还是 CommonJS,单引号还是双引号
- 它不知道哪些文件绝对不能动(比如自动生成的代码、迁移脚本)
- 换个 AI 工具,之前配的规则又得重配一遍
以前每个工具一个配置文件:CLAUDE.md、.cursor/rules、copilot-instructions.md……配了一堆,各管各的。AGENTS.md 把这事统一了:一个文件,所有工具都认。
长什么样:一份给 AI 的"入职文档"
它本质就是一份"新成员入职须知",只不过这个新成员是 AI:
# AGENTS.md
## 环境准备
- 安装依赖:`pnpm install`
- 起开发服:`pnpm dev`
- 跑测试:`pnpm test`
## 代码规范
- TypeScript 严格模式
- 单引号、不加分号
## 边界(重要)
- ✅ 直接做:往 `docs/` 加新文档
- ⚠️ 先问:大改已有文档之前
- 🚫 绝不做:改 `src/` 代码、动配置文件、提交密钥
注意最后那个三档边界——这是 AGENTS.md 最实用的地方。它告诉 AI:什么可以放心干、什么要先问人、什么碰都不许碰。一句话,把"放权"和"兜底"划清楚了。
三个反直觉的实战经验
这个标准从 2.5 万个仓库的实践里总结出几条心法,很反直觉:
1. AI 一次只能记住 150 条指令
很多人以为 AGENTS.md 写得越全越好,堆了 600 行。错。前沿大模型大概只能稳定遵守 150~200 条指令,你写 600 行,它只挑着看一小部分,而且很可能恰好忽略你最在乎的那条。所以 AGENTS.md 的正确写法是"无情的优先级排序"——只留最重要的,详细文档放链接,别整段搬过来。
2. 命令要用反引号包好
写 pnpm test(反引号),AI 才知道这是"可以直接执行"的命令;写成纯文本,它只会当成描述看看。给 AI 的信号越明确,它越不跑偏。
3. 最好的 AGENTS.md 是"长"出来的,不是"规划"出来的
别想着一次写完美。从最小开始(几个命令+几条边界)→ 跑 → AI 犯错了再补对应规则。它是迭代出来的,跟代码一样要维护、要进 code review。
Monorepo 还能"就近覆盖"
大项目(monorepo)一个文件不够用?AGENTS.md 支持嵌套:根目录放通用约定,子目录放各自的专属规则。离代码最近的那份优先——跟 .gitignore 的就近原则一个意思,很符合直觉。
我们的实践:灵核一直在用它
说句实话,看到这个标准我们一点都不陌生——灵核的 AI 助手「格格」就是按这套思路跑的。她的 AGENTS.md 里写着服务器环境、发版铁律、安全红线、"一个功能一个文件"的规矩。这两天我们一边对接企查查数据、一边踩坑,一边就把"血教训"补进她的 AGENTS.md——上面那句"迭代长出来",我们是用真金白银的 bug 验证过的。
如果你也在用 AI 写代码,强烈建议给你的项目加一个 AGENTS.md。成本是十分钟,收益是 AI 从此"懂规矩"。
一句话总结:README 让人类快速上手,AGENTS.md 让 AI 快速上手。AI 编程时代,后者正在变得和前者一样重要。
参考:AGENTS.md 官方规范 agents.md · GitHub agentsmd/agents.md(Linux 基金会 Agentic AI Foundation 管理)
💬 评论 0