- AGENTS.mdはREADMEを補完する役割を持ち、AIコーディングエージェントがプロジェクトで作業する際に必要な文脈と指示をまとめる専用ファイル
- 20,000件以上のオープンソースプロジェクトで使われており、ビルド/テスト/コードスタイルなど、人間には不要でもエージェントには重要な情報を整理
- 明確で予測可能な場所にエージェント専用の指示を提供し、READMEを簡潔に保ちながら協業効率を強化
- 単一のAGENTS.mdでさまざまなエージェントやツールと互換性があり、大規模なモノレポではサブプロジェクトごとの個別AGENTS.mdも利用可能
- OpenAI Codex、Cursor、Google Julesなど複数エコシステムの協業によって作られたオープン標準
Why AGENTS.md?
- README.mdは人間のためのドキュメントであり、クイックスタート、プロジェクト説明、コントリビューションガイドラインを提供
- AGENTS.mdはエージェント向けの補助ドキュメントで、ビルド/テスト/コード規則のような詳細な文脈を含めつつ、READMEを複雑にしない
- 別ファイルにしている理由
- エージェントが参照する予測可能な指示の場所を提供
- READMEは人間のコントリビューター中心に簡潔なまま維持
- 既存ドキュメントを補完する精密なエージェント専用指示を提供
- 独自フォーマットではなく、誰でも使えるオープン標準の名称を採用
- 1つのAGENTS.mdで複数のAIコーディングエージェントやツールと互換
How to use AGENTS.md?
- 1. AGENTS.mdファイルを作成
- リポジトリのルートに配置（多くのエージェントが自動生成をサポート）
- 2. 主要項目を記述
- プロジェクト概要
- ビルドおよびテストコマンド
- コードスタイルのガイドライン
- テスト方法
- セキュリティ上の考慮事項
- 3. 追加指示を含める
- コミット/PRルール、セキュリティ上の注意点、大規模データセット、デプロイ手順など、チームメンバーに伝える内容
- 4. モノレポへの対応
- 各パッケージごとにAGENTS.mdを配置可能
- エージェントは最も近いファイルを読んで、そのサブプロジェクトに適した指示に従う
- 例: OpenAIのリポジトリには88個のAGENTS.mdが存在
FAQ
- 必須項目: なし。一般的なMarkdown形式を自由に使用可能
- 競合が発生した場合: 最も近いAGENTS.mdが優先され、ユーザーが明示したプロンプトが最終適用
- 自動実行の有無: ファイルに記載されたテストコマンドは、エージェントが実行してエラー修正を試みる
- 更新可能性: いつでも変更可能で、生きたドキュメントとして管理
- 既存ドキュメントの移行: ファイル名変更後、シンボリックリンクで互換性を維持
mv AGENT.md AGENTS.md && ln -s AGENTS.md AGENT.md
まだコメントはありません。