Skip to content

custom-agents.md

Latest commit

 

History

History
73 lines (50 loc) · 5.37 KB

custom-agents.md

File metadata and controls

73 lines (50 loc) · 5.37 KB
Raw
title Custom agents
shortTitle Custom agents
intro Give {% data variables.product.prodname_copilot_short %} reusable specialist roles with tailored instructions and tools.
versions
feature
copilot
contentType concepts
redirect_from
/copilot/concepts/agents/about-custom-agents
/copilot/concepts/agents/cloud-agent/about-custom-agents
/copilot/concepts/agents/copilot-cli/about-custom-agents
/copilot/concepts/agents/coding-agent/about-custom-agents
category
Learn about Copilot
Learn about Copilot CLI

{% data variables.copilot.custom_agents_caps_short %} are specialized versions of the {% data variables.product.prodname_copilot_short %} agent that you tailor to particular tasks and workflows. Define a role once instead of repeating its instructions and tool requirements every time you need that expertise.

For example, you can create a documentation specialist that follows your writing standards, or a reviewer that can read and search files but does not need editing tools.

About agent profiles

An agent profile is a Markdown file with YAML frontmatter. It describes the agent's purpose, gives it instructions, and can restrict its available tools. In supported environments, a profile can also configure MCP servers for that agent.

Use a custom agent when you need a reusable role with a particular approach and toolset. If you only need task-specific instructions and resources, a skill can be a simpler choice. For a comparison, see AUTOTITLE.

Profiles can be shared at repository, organization, and enterprise levels. {% data variables.copilot.copilot_cli_short %} also supports personal profiles. Configuration locations, supported properties, and precedence depend on the environment. See AUTOTITLE.

Where you can use custom agents

You can use custom agents with:

  • The {% data variables.copilot.github_copilot_app %}.
  • {% data variables.copilot.copilot_cli %}.
  • {% data variables.copilot.copilot_cloud_agent %} on {% data variables.product.prodname_dotcom_the_website %}, including the agents tab and panel, issue assignment, and pull requests.
  • Supported IDEs, including {% data variables.product.prodname_vscode %}, {% data variables.product.prodname_vs %}, {% data variables.jetbrains.prodname_jetbrains_ides %}, Eclipse, and Xcode.

Custom agents in {% data variables.jetbrains.prodname_jetbrains_ides %} and Xcode are in {% data variables.release-phases.public_preview %}. For IDE-specific version support and release status, see AUTOTITLE.

In an IDE, using a custom agent directly in chat is different from delegating a task to {% data variables.copilot.copilot_cloud_agent %}. A profile's properties can behave differently or be ignored between environments. For {% data variables.product.prodname_vscode_shortname %} profile behavior, see Custom agents in {% data variables.product.prodname_vscode_shortname %}.

Built-in agents

You do not need to define a custom agent for every specialist task. {% data variables.copilot.copilot_cli_short %} includes built-in agents that the main agent can use for common work:

  • explore for codebase exploration
  • task for command execution
  • general-purpose for work requiring a separate agent context
  • code-review for reviewing changes
  • research for research
  • rubber-duck for a second opinion
  • security-review for security-focused review

These are provided by {% data variables.copilot.copilot_cli_short %}, rather than authored as your own profiles. The available tools and behavior differ by agent. For their capabilities and model defaults, see Built-in agents.

Custom agents and subagents

A custom agent is a definition of a specialist. A subagent is an agent doing delegated work in a separate context window. The main agent can delegate to a built-in agent or run a specialist using a custom agent profile.

Separate context lets a subagent focus on its assigned task without adding every intermediate detail to the main conversation. Independent tasks can also run in parallel. These are benefits of delegation, not properties that require you to create a custom profile.

Selecting a custom agent for a session and delegating a subtask to one are different ways of using a profile. In {% data variables.copilot.copilot_cli_short %}, repository instructions are included for the session agent but are not included for a custom subagent by default. For the opt-in setting and invocation methods, see AUTOTITLE.

For the broader delegation model in the {% data variables.copilot.github_copilot_app %} and {% data variables.copilot.copilot_cli_short %}, see AUTOTITLE.

Next steps

Choose the setup guide for where you work: