Skip to content

06 AGENTS.md

你会学到:为什么 AGENTS.md 像项目记忆,以及新手第一版应该写什么。

先做这个

如果你发现自己反复告诉 Codex 同一类规则,就可以写一份最小 AGENTS.md

markdown
# 项目协作规则

- 默认先阅读,不要直接改文件。
- 改动前先说明计划。
- 文档任务只改 Markdown,除非明确要求改代码。
- 不要写入 API Key、Cookie、token、账号信息或客户隐私。
- 完成后说明改动文件、验证方式和剩余风险。

为什么

AGENTS.md 的作用不是展示技术感,而是减少重复沟通。它把项目里的协作规则、验证方式、风格边界写给 Codex 看。

步骤

  1. 先从 5 条规则开始。
  2. 写清楚默认行为:先读、先计划、小范围修改。
  3. 写清楚禁止项:密钥、隐私、生产环境、未授权部署。
  4. 写清楚完成标准:diff、测试、总结、风险。
  5. 真实任务后再补充,不要一开始写太复杂。

常见坑

  • 把密钥或账号信息写进 AGENTS.md
  • 把它写成一篇长论文,Codex 抓不住重点。
  • 只写风格偏好,不写验证方式。
  • 每个项目都复制同一份,不根据场景调整。

完成标准

  • 你知道 AGENTS.md 是项目规则,不是装饰文件。
  • 你能写出一份 5 条以内的最小版本。
  • 你知道下一步可以学习 配置、Skills、MCP

来源与复核

  • 来源:公开教程、AGENTS.md 实践经验和本站整理。
  • 需要复核:官方对 AGENTS.md 的具体读取规则和优先级。

非 OpenAI 官方站。账号、下载、价格、额度和入口名称以官方页面为准。