每个项目都有一个 README.md 文件供人类阅读。但随着 AI 编码代理和 AI 辅助开发的兴起，我们需要一个新标准：AGENTS.md。这个 Markdown 文件定义了代理如何构建、测试和协作。

这就是 AGENTS.md 的作用。

它是一个简单的 Markdown 文件，告诉 AI 助手如何在你的项目中操作：运行哪些命令、如何测试、遵循哪些约定，甚至如何与人类互动。

可以把它想象成给你的 AI 队友的 README。

为什么 AGENTS.md 对 AI 辅助开发至关重要？

这个约定是由 OpenAI 在他们的 agents.md 仓库中引入的，使其与不断增长的 AI 编码代理生态系统兼容。而且有几个明确的原因：

• README.md 是为人类准备的。快速入门、描述、贡献指南。

• AGENTS.md 是为 AI 准备的。它包含编码代理需要的额外详细上下文——构建步骤、测试命令、命名约定——这些内容会让 README 变得杂乱或让人类贡献者感到困惑。

• 关注点分离。保持 README 的简洁，同时给代理提供它们自己的可预测 playbook。

• 互操作性。一个 AGENTS.md 可以跨多种 AI 编码工具工作——没有专有格式，没有锁定。

通过选择大家都已经理解的名称和格式，AGENTS.md 可以无缝融入任何仓库、任何技术栈、任何 IDE。

AI 编码代理的实际 AGENTS.md 示例

以下是一个你可以放到单仓库中的具体示例：