Using custom agents in your IDE

Custom agents allow you to tailor Copilot's expertise for specific tasks. For a conceptual overview of custom agents, see カスタムエージェントについて.

メモ

Custom agents は、JetBrains IDE、Eclipse、Xcode 用パブリックプレビューにあり、変更される可能性があります。

Creating a custom agent profile

Open GitHub Copilot Chat in Visual Studio Code.
From the agents dropdown at the bottom of the chat view, click Configure Custom Agents..., then click Create new custom agent.
Choose the location where the agent profile should be created:
- Workspace: Create the custom agent profile in the .github/agents folder of your workspace to only use it within that workspace.
- User profile: Create the custom agent profile in the current user profile folder to use it across all your workspaces.
Enter a file name for the custom agent. This is the default name that appears in the agents dropdown.
Configure the agent profile in the newly created .agent.md file, including the description, tools, and prompts. For more information on what the agent profile can include, see Configuring an agent profile.
- You can use the Configure Tools... button within the editor to open the "Configure Tools" dialog, where you can view and select available tools, including built-in tools and tools from MCP servers. Click OK to add selected tools to the agent profile.
- To set which AI model the agent uses, add a model: property and select your preferred model from the autocomplete dropdown.

To update an agent profile, select Configure Custom Agents from the agents dropdown, and then click on an agent from the list to modify it. For more information on custom agents in VS Code, see Custom agents in VS Code.

Creating a custom agent profile

Open the GitHub Copilot Chat window in your JetBrains IDE.
From the agents dropdown at the bottom of the chat view, click Configure Agents..., then in the settings window, under "Chat Agents", click Workspace.
Enter a file name for the custom agent. This is the default name that appears in the agents dropdown.
Configure the agent profile in the newly created .agent.md file in the .github/agents directory, including the description, tools, and prompts. For more information on what the agent profile can include, see Configuring an agent profile.
- You can use the Configure Tools... button within the editor to open the tools dialog, where you can view and select available tools, including built-in tools and tools from MCP servers. Click Apply to add selected tools to the agent profile.
- To set which AI model the agent uses, add a model: property and select your preferred model from the autocomplete dropdown.

To update an agent profile, select Configure Custom Agents from the agents dropdown, and then click next to the agent you want to modify.

Creating a custom agent profile

Open the GitHub Copilot Chat window in Eclipse.
From the agents dropdown at the bottom of the chat view, click Configure Agents..., then click Add....
Enter a file name for the custom agent. This is the default name that appears in the agents dropdown.
Configure the agent profile in the newly created .agent.md file in the .github/agents directory, including the description, tools, and prompts. For more information on what the agent profile can include, see Configuring an agent profile.
- You can use the Configure Tools... button within the editor to open the "Configure Tools" dialog, where you can view and select available tools, including built-in tools and tools from MCP servers. Click Apply to add selected tools to the agent profile.
- To set which AI model the agent uses, add a model: property and select your preferred model from the autocomplete dropdown.

To update an agent profile, select Configure Agents... from the agents dropdown, and then select the agent you want to modify and click Edit.

Creating a custom agent profile

Open the GitHub Copilot Chat window in Xcode.
From the agents dropdown at the bottom of the chat view, click Create an agent.
Enter a file name for the custom agent. This is the default name that appears in the agents dropdown.
Configure the agent profile in the newly created .agent.md file in the .github/agents directory, including the description, tools, and prompts. For more information on what the agent profile can include, see Configuring an agent profile.
- You can use the Customize Agent button within the file editor to open a dialog, where you can select the AI model for the agent to use, select available tools (including built-in and MCP server tools), and configure the handoffs property for transitioning between custom agents. Click Apply to add selected options to the agent profile.

To update an agent profile, from the agents dropdown, click the pencil icon next to the agent you want to modify.

Configuring an agent profile

agent profileは、custom agentの名前、説明、使用可能なツール、MCP サーバー構成を指定する YAML frontmatter を含む Markdown ファイルです。 agent profileの構成には、エージェントの ID、機能、ツールアクセス、および動作命令を定義する必要があります。

YAML プロパティ、ツール、MCP サーバーのセットアップ、ツールエイリアス、および custom agents の処理方法の詳細については、カスタムエージェントの構成を参照してください。

agent profileを構成するには:

オプションで、name用のcustom agentを記述します。設定を解除すると、名前は既定でファイル名に設定されます ( .md または .agent.md サフィックスは付けなくなります)。
エージェントの機能と、その特定の機能またはドメインの専門知識を説明する簡単な description (必須) を記述します。
tools プロパティで、エージェントで使用できるツールを定義します。これは、リポジトリ設定または agent profile ( tools: ["read", "edit", "search", "some-mcp-server/tool-1"] など) で構成された MCP サーバーのツールを含む、ツール名またはエイリアスの一覧です。このプロパティを省略すると、エージェントは使用可能なすべてのツールにアクセスできます。カスタムエージェントの構成の「ツール」を参照してください。
必要に応じて、 mcp-servers プロパティで、このエージェントのみが使用できる MCP サーバーを構成して、その機能を拡張できます。カスタムエージェントの構成の「MCP サーバー構成の詳細」を参照してください。
agent profile、JetBrains IDE、Eclipse、または Xcode でVS Codeを作成して使用する場合は、model プロパティを使用して、エージェントが使用する AI モデルを制御することもできます。
必要に応じて、特定の環境でのみエージェントを使用する場合は、 target プロパティを vscode または github-copilot に設定します。このプロパティを省略すると、エージェントは両方の環境で使用できます。
エージェントのプロンプトを書いてください。 YAML frontmatter の下にある Markdown コンテンツで、エージェントの動作、専門知識、および手順を定義します。プロンプトの最大文字数は 30,000 文字です。

Example agent profiles

次の例は、agent profile が、テストの記述やプロジェクトの計画に関連する一般的なタスクにおいてどのように見えるかを示しています。その他のヒントについては、カスタマイズライブラリの Custom agents の例を参照してください。さらに具体的な例については、 awesome-copilot コミュニティコレクションを参照してください。

テストスペシャリスト

この例では、 tools プロパティを省略して、すべてのツールを有効にします。

Text

---
name: test-specialist
description: Focuses on test coverage, quality, and testing best practices without modifying production code
---

You are a testing specialist focused on improving code quality through comprehensive testing. Your responsibilities:

- Analyze existing tests and identify coverage gaps
- Write unit tests, integration tests, and end-to-end tests following best practices
- Review test quality and suggest improvements for maintainability
- Ensure tests are isolated, deterministic, and well-documented
- Focus only on test files and avoid modifying production code unless specifically requested

Always include clear test descriptions and use appropriate testing patterns for the language and framework.

---
name: test-specialist
description: Focuses on test coverage, quality, and testing best practices without modifying production code
---

You are a testing specialist focused on improving code quality through comprehensive testing. Your responsibilities:

- Analyze existing tests and identify coverage gaps
- Write unit tests, integration tests, and end-to-end tests following best practices
- Review test quality and suggest improvements for maintainability
- Ensure tests are isolated, deterministic, and well-documented
- Focus only on test files and avoid modifying production code unless specifically requested

Always include clear test descriptions and use appropriate testing patterns for the language and framework.

実装プランナー

この例では、ツールのサブセットのみを有効にします。

Text

---
name: implementation-planner
description: Creates detailed implementation plans and technical specifications in markdown format
tools: ["read", "search", "edit"]
---

You are a technical planning specialist focused on creating comprehensive implementation plans. Your responsibilities:

- Analyze requirements and break them down into actionable tasks
- Create detailed technical specifications and architecture documentation
- Generate implementation plans with clear steps, dependencies, and timelines
- Document API designs, data models, and system interactions
- Create markdown files with structured plans that development teams can follow

Always structure your plans with clear headings, task breakdowns, and acceptance criteria. Include considerations for testing, deployment, and potential risks. Focus on creating thorough documentation rather than implementing code.

---
name: implementation-planner
description: Creates detailed implementation plans and technical specifications in markdown format
tools: ["read", "search", "edit"]
---

You are a technical planning specialist focused on creating comprehensive implementation plans. Your responsibilities:

- Analyze requirements and break them down into actionable tasks
- Create detailed technical specifications and architecture documentation
- Generate implementation plans with clear steps, dependencies, and timelines
- Document API designs, data models, and system interactions
- Create markdown files with structured plans that development teams can follow

Always structure your plans with clear headings, task breakdowns, and acceptance criteria. Include considerations for testing, deployment, and potential risks. Focus on creating thorough documentation rather than implementing code.