Agile育成ブログ
未来を変える喜びを
未分類

🤖 GitHub Copilotを「専任アシスタント」に進化させる：AGENTS.md徹底解説

 

.github/agents/ ディレクトリに agents.md ファイルを配置することで、カスタムエージェントを定義し、Issue に定義したカスタムエージェントをアサインできるようになっています。従来の汎用アシスタントではなく、バックエンド専用の @backend-specialist、フロントエンド専用の @frontend-specialist、SRE専用の @sre-specialist など、専門性を持ったエージェントチームを構築できる

💡 AGENTS.mdとは？

AGENTS.mdは、GitHub Copilotのコーディングエージェント（Copilot Coding Agent）に対して、プロジェクト固有のコンテキストや作業手順を指示するための特別なMarkdownファイルです。

このファイルをリポジトリのルート（またはサブディレクトリ）に配置することで、Copilotはプロジェクトの「専任エンジニア」として、より正確で、よりプロジェクトの慣習に合ったコード作業を行うことができるようになります。

📌 README.mdとの役割の違い

ファイル名目的読み手内容
README.mdプロジェクトの概要、クイックスタート、貢献ガイドライン人間（開発者、利用者）プロジェクトの顔となる説明
AGENTS.mdビルド手順、テストコマンド、コーディング規約、セキュリティ考慮事項AI（Copilot Coding Agent）AIエージェントが自律的に作業するための詳細な実行コンテキスト

AGENTS.mdは、README.mdには書くと煩雑になりすぎるが、AIエージェントが作業を成功させるために不可欠な「裏側の情報」を提供する役割を果たします。

🚀 AGENTS.mdでできること

AGENTS.mdの導入により、Copilot Coding Agentの能力を以下のようにカスタマイズ・強化できます。

1. プロジェクト規約の徹底

  • コーディングスタイル: 「このプロジェクトではインデントはスペース4つ、セミコロンは使用しない」「変数名はキャメルケースを使用する」など、具体的なコーディング規約を記述することで、Copilotが生成するコードが一貫性を持ちます。
  • テスト手順の定義: バグ修正や新機能実装の際に、Copilotが変更後に実行すべきテストコマンド（例: npm run test、pytest）を明記できます。これにより、AIが自律的に変更の検証を行うことが可能になります。

2. 環境設定の伝達

  • ビルドコマンド: プロジェクトのビルドに必要な特定のコマンドや手順（例: docker-compose up、特定の環境変数の設定）を記述します。
  • 技術スタックの強調: 「主要なフレームワークはReactとTailwind CSSである」といった情報を与えることで、AIが適切なライブラリやコンポーネント構造を優先して提案するようになります。

3. モノレポ構造への対応（入れ子のAGENTS.md）

大規模なモノレポ（複数のプロジェクトを単一のリポジトリで管理する構造）の場合、各サブプロジェクトのディレクトリ内にAGENTS.mdを配置できます。

  • 優先順位: Copilotは、作業を行っているファイルに最も近いディレクトリにあるAGENTS.mdの内容を優先して読み込みます。
  • これにより、パッケージごとに異なる言語、ビルド手順、コーディング規約をAIに正確に伝えることが可能になります。

🛠️ 記述方法と配置場所

AGENTS.mdの形式は自由なMarkdown形式ですが、見出しを使って情報を整理することが推奨されます。

推奨されるセクション例

Markdown

# AGENTS.md

## Project Overview
このリポジトリは、Next.jsとTypeScriptを使用したeコマースのバックエンドAPIです。

## Build Commands
ローカルでの実行には以下のコマンドを使用してください。
```shell
npm install
npm run dev

Testing Instructions

変更を加えた後は、必ず統合テストを実行する必要があります。

Shell

npm run test:integration

Code Style Guidelines

すべてのJavaScriptコードはPrettierのデフォルト設定に従うものとし、コメントはすべて日本語で記述してください。


### ファイルの配置

* **リポジトリ全体:** `[リポジトリのルート]/AGENTS.md`
* **サブプロジェクト:** `[リポジトリのルート]/packages/client/AGENTS.md`

## 🌟 まとめ：AI時代の「貢献ガイドライン」

`AGENTS.md`は、AI時代における新しい形の**「貢献ガイドライン」**と言えます。

AIエージェントが人間に代わってIssueの修正やPRの作成を行う中で、**「何をすべきか（目的）」**だけでなく、**「どのようにすべきか（手順と規約）」**を明確に伝えるための基盤となります。これにより、Copilotは単なるコード提案者ではなく、チームの一員として自律的に価値を生み出す存在へと進化します。

---

この解説記事の内容について、**「カスタムエージェントの作成手順（`.agent.md`フ
RELATED POST