agents.md
让AI编码代理读懂项目上下文
安装使用
复制下面这段提示词发给你的 AI（Claude / Cursor / TRAE / Codex / WorkBuddy 等），它会自动帮你完成安装：
帮我安装这个 AI Skill：agents.md。 它的用途是：让AI编码代理读懂项目上下文 完整的 Skill 内容见：https://321skill.com/skills/agents-md/raw/index.md 请读取该页面内容，如果是 SKILL.md 格式直接安装，如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接，AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'请根据项目根目录的AGENTS.md配置来优化我的开发环境，并告诉我如何运行测试。'，AI会读取文件中的开发环境提示和测试指令，自动执行pnpm install --filter等命令，并按照PR规范提交代码。
介绍
这个Skill解决了AI编码代理缺乏项目上下文、频繁出错的问题。在实际开发中，开发者经常需要反复向AI解释项目结构、环境配置、测试命令和提交规范，导致效率低下。AGENTS.md提供了一种标准化的方式，让AI代理在开始工作前就自动获取所有必要信息，就像人类开发者阅读README一样自然。
使用方式很简单，你只需要在项目根目录创建一个AGENTS.md文件，按照Markdown格式编写开发环境提示、测试指令、PR提交规范等内容。之后AI代理在启动时会自动读取该文件，并据此调整行为。例如，你可以告诉AI“使用pnpm dlx turbo run`跳转到包目录”，或者“运行pnpm lint和pnpm test后再提交”，AI就会自动遵循这些规则。
它非常适合需要频繁与AI编码代理协作的团队或个人。尤其是那些已经使用Claude、Cursor、Trae等AI编程工具的大型项目，或者多人协作、需要统一AI行为规范的中型项目。对于前端/后端/全栈开发者，以及需要管理复杂项目结构的项目经理，这个格式能显著减少沟通成本。
建议在项目初始化或重构时统一创建AGENTS.md文件。需要注意的是，它主要面向AI代理，与人类开发者阅读的README.md互补而非替代；同时格式本身非常简洁，不需要额外工具或依赖，仅需Markdown即可。目前该格式仍在推广中，并非所有AI编码代理工具都原生支持，但可以通过手动提供文件路径的方式使用。
常见问题
AGENTS.md和README.md有什么区别？
README.md面向人类开发者，介绍项目功能、安装和使用；AGENTS.md面向AI编码代理，提供开发环境细节、测试命令、PR规范等，帮助AI正确工作。
如何让AI编码代理读取AGENTS.md？
目前部分AI工具（如Claude Code）会自动读取，否则需在对话开始时手动提供文件内容或路径。
给 AI 助手的安装指引
如果你的 AI 编程助手（Claude Code、Cursor、TRAE 等）能看到这个页面，把下面这段发给它即可自动完成安装：
请访问 https://321skill.com/skills/agents-md/raw/index.md 读取 agents.md 的原始 Skill 定义（Markdown 格式），按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址：/skills/agents-md/raw/index.md（查看排版版本）