如果您使用过克劳德代码(Claude Code)、光标(Cursor)、科德克斯(Codex)、艾德(Aider)、杰米尼命令行界面(Gemini CLI)、吉特哈布 copil ot(GitHub Copilot)、格罗克(Grok)、古斯(goose)或类似工具,您会看到相同的模式:智能体的首要任务是上下文。这是什么项目?如何构建它?如何运行测试?应遵循哪些约定?绝不能破坏什么?
AGENTS.md 是开放的答案。它是一个放置在仓库根目录的单一 Markdown 文件,作为面向人工智能编码智能体的专用、可预测的简报。可以将其视为专门写给智能体而非人类阅读的自述文件(README)。其格式刻意保持简单且与工具无关——一个文件即可在许多不同的智能体上通用。
AGENTS.md 由开放人工智能(OpenAI)的科德克斯(Codex)首创,并与光标(Cursor)、安普(Amp)、工厂(Factory)以及谷歌(Google)的朱尔斯(Jules)等工具共同塑造。2025年12月,它被捐赠给 Linux 基金会旗下的代理式人工智能基金会(Agentic AI Foundation),目前作为开放标准进行管理。
大多数 AGENTS.md 文件失败的原因不外乎两种:要么内容过于单薄而无用,要么是冗长散漫的文档,导致智能体仅略读并大部分忽略。优秀的 AGENTS.md 介于两者之间——简短、时效性强、具体且可操作。
README 供人类阅读。AGENTS.md 供智能体阅读。
这一区别决定了文件中应包含的所有内容。
- README.md 回答是什么和为什么:项目是什么,为何存在,以及人类如何开始使用。
- AGENTS.md 回答如何在此工作:智能体进行更改并验证这些更改而无需提问所需的确切命令、约定和安全护栏。
不要复制 README 中的内容。如果智能体不需要它来有效行动,就将其省略。每一行非必要的文字都会稀释核心信号。
AGENTS.md 中实际应包含的内容
按大致优先级排序的高价值部分。
一行导向说明。 用一句话告诉智能体项目是什么以及使用何种技术栈——例如,“一个基于 Node 20 和 Postgres 构建并部署到 Fly.io 的 TypeScript REST API。”
设置和构建命令。 最有价值的部分。提供真实、可直接复制粘贴的命令:
npm install
npm run build
npm run dev
如何运行测试。 甚至比构建命令更重要——测试是智能体验证自身工作的方式:
npm test # 在认为更改完成之前,所有测试必须通过
npm run lint
npm run typecheck
文件位置分布。 关键目录和入口点的简短、聚焦地图——而非完整的目录树转储。
约定规范。 您希望遵循的具体模式:验证方法、错误处理、命名规范、首选库、架构决策。像“编写整洁代码”这样模糊的陈述毫无用处;像“在路由边界处使用 Zod 验证所有输入”这样的具体规则则非常有用。
提交和拉取请求(PR)规则。 消息格式、分支命名、变更日志更新以及任何其他流程要求。
安全护栏——禁止事项。 防止昂贵错误的地雷区:不要编辑 /generated 中的文件,切勿针对生产配置运行数据库迁移,也不要直接提交到主分支(main)。
使其比没有更糟糕的反面模式
糟糕的 AGENTS.md 不仅无法提供帮助——还会 actively 误导智能体。
-
长篇大论:太长。
免责声明:本文内容来自互联网,该文观点不代表本站观点。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容,请到页面底部单击反馈,一经查实,本站将立刻删除。