第二十六课：AGENTS.md 入门

学习目标

• 理解 AGENTS.md 的概念和作用
• 掌握基本格式和语法
• 了解为什么 AGENTS.md 对 AI 编码代理很重要

一、什么是 AGENTS.md

AGENTS.md 是一个开放格式的配置文件，用于指导 AI 编码代理如何处理你的项目。它就像是给 AI 写的 README，告诉代理：

• 项目使用什么技术栈
• 如何安装依赖和运行项目
• 代码风格和规范是什么
• 如何运行测试
• 有哪些已知问题或特殊约定

AGENTS.md 最初由 OpenAI Codex 提出，现在已被 30+ 个 AI 编码工具支持，包括 Cursor、GitHub Copilot、Claude Code 等。

二、为什么 AGENTS.md 很重要

2.1 提供项目上下文

没有 AGENTS.md 时，代理需要自己探索项目结构，这可能花费大量时间、遗漏重要信息、做出错误假设。有了 AGENTS.md，代理可以立即了解项目的关键信息。

2.2 定义编码规范

每个项目都有自己的编码规范，AGENTS.md 可以告诉代理使用什么命名约定、如何组织代码结构、使用什么测试框架、提交信息的格式。

2.3 提高代理效率

研究表明，使用 AGENTS.md 的项目，代理的工作效率可以提高 30-50%。

三、基本格式

AGENTS.md 使用 Markdown 格式，包含项目概述、环境设置、代码规范、测试指南、部署流程等部分。

四、AGENTS.md 与 README.md 的区别

方面	README.md	AGENTS.md
目标读者	人类开发者	AI 代理
内容重点	项目介绍、使用说明	技术细节、开发规范
格式要求	自由格式	结构化格式

五、支持的代理工具

AGENTS.md 被 30+ 代理工具支持，包括 OpenAI Codex、Claude Code、Cursor、GitHub Copilot、Google Jules、JetBrains Junie 等。

六、本课小结

AGENTS.md 是给 AI 代理的项目指南，提供上下文、定义规范、提高效率。使用 Markdown 格式，被 30+ 代理工具支持。

下一步

下一课我们将学习如何编写高质量的 AGENTS.md。