每個項目都有一個 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 示例
以下是一個你可以放到單倉庫中的具體示例: