October 28-29: GitHub Universe 2025 docs-internal megabranch (#57869)
Signed-off-by: Meredith Lancaster <malancas@users.noreply.github.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Anne-Marie <102995847+am-stead@users.noreply.github.com> Co-authored-by: Felicity Chapman <felicitymay@github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: AlonaHlobina <54394529+AlonaHlobina@users.noreply.github.com> Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Co-authored-by: Jules <19994093+jules-p@users.noreply.github.com> Co-authored-by: Siara <108543037+SiaraMist@users.noreply.github.com> Co-authored-by: Kelly Arwine <kellyarwine@github.com> Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com> Co-authored-by: Jon Janego <jonjanego@github.com> Co-authored-by: Jules Porter <jules-p@users.noreply.github.com> Co-authored-by: hubwriter <hubwriter@github.com> Co-authored-by: Laurenzo <lsto@github.com> Co-authored-by: Sam Browning <106113886+sabrowning1@users.noreply.github.com> Co-authored-by: Vanessa <vgrl@github.com> Co-authored-by: Melanie Yarbrough <11952755+myarb@users.noreply.github.com> Co-authored-by: Claire W <78226508+crwaters16@users.noreply.github.com> Co-authored-by: Felix Guntrip <guntrip@github.com> Co-authored-by: James Fletcher <42464962+jf205@users.noreply.github.com> Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com> Co-authored-by: Tim Rogers <timrogers@github.com> Co-authored-by: docs-bot <77750099+docs-bot@users.noreply.github.com> Co-authored-by: Guillaume Perrot <guperrot@github.com> Co-authored-by: Mark Tareshawty <tarebyte@github.com> Co-authored-by: Hirsch Singhal <1666363+hpsin@users.noreply.github.com> Co-authored-by: Emily Gould <4822039+emilyistoofunky@users.noreply.github.com> Co-authored-by: Sunbrye Ly <56200261+sunbrye@users.noreply.github.com> Co-authored-by: PJ Quirk <pjquirk@github.com> Co-authored-by: Steve Ward <steveward@github.com> Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com> Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com> Co-authored-by: SiaraMist <siaramist@github.com> Co-authored-by: Tomoko Tanaka <28242405+tallzeebaa@users.noreply.github.com> Co-authored-by: a1exmozz <187176404+a1exmozz@users.noreply.github.com> Co-authored-by: Meredith Lancaster <malancas@users.noreply.github.com> Co-authored-by: Sarah Schneider <sarahs@users.noreply.github.com> Co-authored-by: Andy Barnes <kurgol@github.com> Co-authored-by: Sheena Ganju <sheenyg@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Sydney Wilson <86739163+swilson15@users.noreply.github.com> Co-authored-by: Robert Sese <734194+rsese@users.noreply.github.com> Co-authored-by: Vimala Moger <166641453+VimalaMoger@users.noreply.github.com> Co-authored-by: Sharra-writes <sharra-writes@github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Jenni C <97056108+dihydroJenoxide@users.noreply.github.com> Co-authored-by: Greg Mondello <72952982+gmondello@users.noreply.github.com> Co-authored-by: Mia Arts <107727642+its-mia@users.noreply.github.com> Co-authored-by: sunbrye <sunbrye@github.com> Co-authored-by: Lorenz Vanthillo <lorenz.vanthillo@gmail.com> Co-authored-by: Eboni <32157169+EboniLM@users.noreply.github.com> Co-authored-by: Junko Suzuki <pnsk@github.com> Co-authored-by: Alex Nguyen <150945400+nguyenalex836@users.noreply.github.com> Co-authored-by: heiskr <1221423+heiskr@users.noreply.github.com> Co-authored-by: Patrick Knight <patrick-knight@github.com> Co-authored-by: T. Greg Doucette <58960990+LawDevNull@users.noreply.github.com> Co-authored-by: Evan Bonsignori <ebonsignori@github.com> Co-authored-by: Robert Justin Monzingo <robertjmonzingo@gmail.com> Co-authored-by: John Coleman <thenewcoke@gmail.com> Co-authored-by: Brendan Scott-Smith <117171930+bss-mc@users.noreply.github.com> Co-authored-by: Chad Bentz <1760475+felickz@users.noreply.github.com> Co-authored-by: Justin Alex <1155821+jusuchin85@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: azenMatt <7584089+azenMatt@users.noreply.github.com> Co-authored-by: Felix Guntrip <stevecat@github.com> Co-authored-by: timrogers <116134+timrogers@users.noreply.github.com> Co-authored-by: John Clement <70238417+jclement136@users.noreply.github.com> Co-authored-by: vaindil <vaindil@github.com> Co-authored-by: Matthew Isabel <matthewisabel@github.com> Co-authored-by: Matthew Isabel <matthew.isabel@gmail.com>
This commit is contained in:
Sophie
@@ -20,8 +20,34 @@ contentType: concepts
|
||||
|
||||
{% data variables.product.prodname_copilot_short %} can review code written in any programming language.
|
||||
|
||||
{% data variables.copilot.copilot_code-review_short %} acts as an intelligent agent, reviewing your code from various angles—such as planning, customizing, and deduplicating—to systematically uncover insights, identify issues, and suggest fixes.
|
||||
|
||||
This article provides an overview of {% data variables.copilot.copilot_code-review_short %}. For instructions on how to request a code review from {% data variables.product.prodname_copilot_short %}, see [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/using-copilot-code-review).
|
||||
|
||||
### {% data variables.copilot.copilot_code-review-tools-preview_cap %}
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> * The [AUTOTITLE](/free-pro-team@latest/site-policy/github-terms/github-pre-release-license-terms) apply to your use of this product.
|
||||
> * These tools are enabled automatically for {% data variables.copilot.copilot_pro %} or {% data variables.copilot.copilot_pro_plus %} plans.
|
||||
> * If you get a {% data variables.product.prodname_copilot_short %} subscription from an organization, you will only be able to participate in the {% data variables.release-phases.public_preview %} on the {% data variables.product.github %} website if an owner of your organization or enterprise has enabled **Copilot in GitHub.com > Opt in to preview features** in the **{% data variables.product.prodname_copilot %} policies** page of the organization or enterprise settings. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/managing-policies-for-copilot-in-your-organization#enabling-copilot-features-in-your-organization) and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-enterprise-policies).
|
||||
|
||||
{% data variables.copilot.copilot_code-review_short %} has several new tools that are in {% data variables.release-phases.public_preview %} and subject to change.
|
||||
|
||||
* **Full project context gathering** to provide more specific, accurate, and contextually aware code reviews.
|
||||
* **Support for deterministic detections like {% data variables.product.prodname_codeql %} and security findings**, to deliver more high-signal, consistent findings for security and quality.
|
||||
* **The ability to pass suggestions to {% data variables.copilot.copilot_coding_agent %}**, for automated creation of a new pull request against your branch with the suggested fixes applied.
|
||||
|
||||
You are not required to have {% data variables.product.prodname_code_scanning %} and {% data variables.product.prodname_actions %} enabled in your organization or enterprise to use the {% data variables.copilot.copilot_code-review-tools_short %}.
|
||||
|
||||
In the event that {% data variables.product.prodname_actions %} is unavailable or if Actions workflows used by {% data variables.copilot.copilot_code-review_short %} fail, reviews will still be generated but without the additional features provided by the {% data variables.copilot.copilot_code-review-tools_short %}.
|
||||
|
||||
> [!NOTE]
|
||||
>
|
||||
> The {% data variables.release-phases.public_preview %} includes free actions minutes for the {% data variables.copilot.copilot_code-review-tools_short %}.
|
||||
>
|
||||
> Usage charges will apply when the feature becomes generally available.
|
||||
|
||||
## Availability
|
||||
|
||||
{% data variables.copilot.copilot_code-review_short %} is supported in:
|
||||
@@ -33,7 +59,7 @@ This article provides an overview of {% data variables.copilot.copilot_code-revi
|
||||
* Xcode
|
||||
* JetBrains IDEs
|
||||
|
||||
{% data variables.copilot.copilot_code-review_short %} is—with one exception—a premium feature, available with the {% data variables.copilot.copilot_pro_short %}, {% data variables.copilot.copilot_pro_plus_short %}, {% data variables.copilot.copilot_business_short %}, and {% data variables.copilot.copilot_enterprise_short %} plans.
|
||||
{% data variables.copilot.copilot_code-review_short %} is—with one exception—a premium feature, available with the {% data variables.copilot.copilot_pro_short %}, {% data variables.copilot.copilot_pro_plus_short %}, {% data variables.copilot.copilot_business_short %}, and {% data variables.copilot.copilot_enterprise_short %} plans. See [Copilot plans](https://github.com/features/copilot/plans?ref_product=copilot&ref_type=purchase&ref_style=text&utm_source=docs-signup-copilot&utm_medium=docs&utm_campaign=universe25).
|
||||
|
||||
The exception is the review of a selection of code within a file in {% data variables.product.prodname_vscode %}. This is a standard feature available to all {% data variables.product.prodname_copilot_short %} users in {% data variables.product.prodname_vscode_shortname %}.
|
||||
|
||||
@@ -60,11 +86,9 @@ When you reach your monthly quota you will not be able to get a code review from
|
||||
* **Review selection:**
|
||||
* Highlight code and ask for an initial review.
|
||||
* Standard {% data variables.product.prodname_copilot_short %} feature. No premium requests used.
|
||||
* Does not support custom instructions.
|
||||
* **Review changes:**
|
||||
* Request a deeper review of all of your uncommitted changes.
|
||||
* Premium feature. Uses one premium request from your monthly quota per review.
|
||||
* Supports custom instructions.
|
||||
|
||||
## Providing instructions for {% data variables.product.prodname_copilot_short %} code reviews
|
||||
|
||||
@@ -101,12 +125,16 @@ The triggers for automatic code review depend on the configuration settings:
|
||||
|
||||
### Limits on automatic pull request reviews
|
||||
|
||||
{% data variables.copilot.copilot_code-review_short %} is a premium feature with a per-person monthly quota. When {% data variables.product.prodname_copilot_short %} carries out an automatic review, it uses one premium request from the quota of the user who created the pull request. For more information, see [AUTOTITLE](/copilot/using-github-copilot/code-review/using-copilot-code-review#code-review-monthly-quota).
|
||||
{% data variables.copilot.copilot_code-review_short %} is a premium feature with a per-person monthly quota. When {% data variables.product.prodname_copilot_short %} carries out an automatic review, it uses one premium request from the quota of the user who created the pull request. For more information, see [AUTOTITLE](/copilot/concepts/agents/code-review#code-review-monthly-quota).
|
||||
|
||||
## Configuring automatic pull request reviews
|
||||
|
||||
For details of how to configure {% data variables.product.prodname_copilot_short %} to automatically review new pull requests, see [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/configuring-automatic-code-review-by-copilot).
|
||||
|
||||
## Getting detailed code quality feedback for your whole repository
|
||||
|
||||
{% data variables.copilot.copilot_code-review %} reviews your code in pull requests and provides feedback. If you want to surface actionable feedback on the reliability and maintainability of your whole repository, enable {% data variables.product.prodname_code_quality %}. See [AUTOTITLE](/code-security/code-quality/concepts/about-code-quality).
|
||||
|
||||
## Further reading
|
||||
|
||||
* [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/using-copilot-code-review)
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: About GitHub Copilot coding agent
|
||||
shortTitle: About coding agent
|
||||
intro: You can assign {% data variables.product.github %} issues to {% data variables.product.prodname_copilot_short %}, or ask {% data variables.product.prodname_copilot_short %} to create a pull request.
|
||||
intro: You can ask {% data variables.product.prodname_copilot_short %} to open a new pull request or make changes to an existing pull request. {% data variables.product.prodname_copilot_short %} works in the background, then requests a review from you.
|
||||
product: '{% data reusables.gated-features.copilot-coding-agent %}<br><a href="https://github.com/features/copilot/plans?ref_product=copilot&ref_type=engagement&ref_style=button" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Sign up for {% data variables.product.prodname_copilot_short %}</span> {% octicon "link-external" height:16 %}</a>'
|
||||
versions:
|
||||
feature: copilot
|
||||
@@ -33,20 +33,23 @@ With {% data variables.copilot.copilot_coding_agent %}, {% data variables.produc
|
||||
|
||||
To delegate tasks to {% data variables.product.prodname_copilot_short %}, you can:
|
||||
|
||||
* Assign an issue to {% data variables.product.prodname_copilot_short %}. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/using-copilot-to-work-on-an-issue).
|
||||
* Ask {% data variables.product.prodname_copilot_short %} to create a pull request from the agents panel or page on {% data variables.product.github %}, {% data variables.copilot.copilot_chat %}, your favorite IDE or agentic coding tool with MCP support, or Raycast on macOS. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/asking-copilot-to-create-a-pull-request).
|
||||
* Ask Copilot to open a new pull request from many places, including {% data variables.product.prodname_github_issues %}, {% data variables.product.prodname_vscode %} and the agents panel available on every page on {% data variables.product.github %}. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr).
|
||||
* Mention `@copilot` in a comment on an existing pull request to ask it to make changes. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/make-changes-to-an-existing-pr).
|
||||
{% ifversion security-campaigns-assign-to-cca %}* Assign security alerts to {% data variables.product.prodname_copilot_short %} from security campaigns. See [AUTOTITLE](/code-security/code-scanning/managing-code-scanning-alerts/fixing-alerts-in-security-campaign#assigning-alerts-to-copilot-coding-agent).{% endif %}
|
||||
|
||||
{% data variables.product.prodname_copilot_short %} will evaluate the task it has been assigned based on the prompt you give it—whether that's from the issue description or a chat message. Then {% data variables.product.prodname_copilot_short %} will make the required changes and open a pull request. When {% data variables.product.prodname_copilot_short %} finishes, it will request a review from you, and you can leave pull request comments to ask {% data variables.product.prodname_copilot_short %} to iterate.
|
||||
|
||||
While working on a coding task, {% data variables.product.prodname_copilot_short %} has access to its own ephemeral development environment, powered by {% data variables.product.prodname_actions %}, where it can explore your code, make changes, execute automated tests and linters and more.
|
||||
|
||||
You can also create {% data variables.copilot.custom_agents_short %} to tailor {% data variables.product.prodname_copilot_short %}'s behavior for specific workflows, coding conventions, or specialized tasks. {% data variables.copilot.custom_agents_caps_short %} allow you to define multiple specialized versions of the coding agent—such as a frontend reviewer, test generator, or security auditor—each with their own prompts, tools, and capabilities. For more information, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents).
|
||||
|
||||
### Benefits over traditional AI workflows
|
||||
|
||||
When used effectively, {% data variables.copilot.copilot_coding_agent %} offers productivity benefits over traditional AI assistants in IDEs:
|
||||
|
||||
* With **AI assistants in IDEs**, coding happens **locally**. Individual developers pair in **synchronous** sessions with the AI assistant. Decisions made during the session are **untracked** and lost to time unless committed. Although the assistant helps write code, the developer still has a lot of **manual steps** to do: create the branch, write commit messages, push the changes, open the PR, write the PR description, get a review, iterate in the IDE, and repeat. These steps take time and effort that may be hard to justify for simple or routine issues.
|
||||
|
||||
* With **{% data variables.copilot.copilot_coding_agent %}**, all coding and iterating happens **on {% data variables.product.github %}** as part of the pull request workflow. {% data variables.product.prodname_copilot_short %} **automates** branch creation, commit message writing and pushing, PR opening, and PR description writing. Developers let the agent **work in the background** and then steer {% data variables.product.prodname_copilot_short %} to a final solution using PR reviews. Working on {% data variables.product.github %} adds **transparency**, where every step happens in a commit and is viewable in logs. Working on {% data variables.product.github %} also opens up **collaboration** opportunities for the entire team.
|
||||
* With **{% data variables.copilot.copilot_coding_agent %}**, all coding and iterating happens **on {% data variables.product.github %}** as part of the pull request workflow. You can create multiple {% data variables.copilot.custom_agents_short %} that specialize in different types of tasks. {% data variables.product.prodname_copilot_short %} **automates** branch creation, commit message writing and pushing, PR opening, and PR description writing. Developers let the agents **work in the background** and then steer {% data variables.product.prodname_copilot_short %} to a final solution using PR reviews. Working on {% data variables.product.github %} adds **transparency**, with every step happening in a commit and being viewable in logs, and opens up **collaboration** opportunities for the entire team.
|
||||
|
||||
### {% data variables.copilot.copilot_coding_agent %} versus agent mode
|
||||
|
||||
@@ -62,6 +65,12 @@ Having {% data variables.product.prodname_copilot_short %} as an additional codi
|
||||
|
||||
{% data variables.product.prodname_copilot_short %} can start a task, which you then pick up and continue working on yourself. By assigning the initial work to {% data variables.product.prodname_copilot_short %}, you free up time that you would otherwise have spent doing repetitive tasks, such as setting up the scaffolding for a new project.
|
||||
|
||||
You can create specialized {% data variables.copilot.custom_agents_short %} for different tasks. For example, you might create a {% data variables.copilot.copilot_custom_agent_short %} specialized for frontend development that focuses on React components and styling, a documentation agent that excels at writing and updating technical documentation, or a testing agent that specializes in generating comprehensive unit tests. Each {% data variables.copilot.copilot_custom_agent_short %} can be tailored with specific prompts and tools suited to its particular task.
|
||||
|
||||
### Integrating {% data variables.copilot.copilot_coding_agent %} with third-party tools
|
||||
|
||||
You can also invoke {% data variables.copilot.copilot_coding_agent %} from external tools, allowing you to assign tasks to {% data variables.product.prodname_copilot_short %}, provide context, and open pull requests without leaving your workflow. See [AUTOTITLE](/copilot/concepts/tools/about-copilot-integrations)
|
||||
|
||||
### Making {% data variables.copilot.copilot_coding_agent %} available
|
||||
|
||||
Before you can assign tasks to {% data variables.copilot.copilot_coding_agent %}, it must be enabled.
|
||||
@@ -86,6 +95,11 @@ For more information, see [AUTOTITLE](/billing/managing-billing-for-your-product
|
||||
|
||||
Security is a fundamental consideration when you enable {% data variables.copilot.copilot_coding_agent %}, as with any other AI agent. {% data variables.product.prodname_copilot_short %} has a strong base of built-in security protections that you can supplement by following best practice guidance.
|
||||
|
||||
* **Validated for security issues**: {% data variables.product.prodname_copilot_short %} analyzes the code created by {% data variables.copilot.copilot_coding_agent %} for security issues and attempts to resolve them prior to completing the pull request. This reduces the likelihood of the code generated by {% data variables.copilot.copilot_coding_agent %} introducing problems such as hardcoded secrets, insecure dependencies, and other vulnerabilities. Details about the analysis performed and the actions taken by {% data variables.copilot.copilot_coding_agent %} can be reviewed in the session log. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/track-copilot-sessions).
|
||||
* **{% data variables.product.prodname_codeql %}** is used to identify code security issues.
|
||||
* Newly introduced dependencies are checked against the **{% data variables.product.prodname_advisory_database %}** for malware advisories, and for any CVSS-rated High or Critical vulnerabilities.
|
||||
* **{% data variables.product.prodname_secret_scanning_caps %}** is used to detect sensitive information such as API keys, tokens, and other secrets.
|
||||
* {% data variables.copilot.copilot_coding_agent %}'s security validation **does not require** a {% data variables.product.prodname_GHAS_cs_or_sp %} license.
|
||||
* **Subject to existing governance**: Organization settings and enterprise policies control availability. Any security policies and practices set up for the organization also apply to {% data variables.copilot.copilot_coding_agent %}.
|
||||
* **Restricted development environment**: {% data variables.product.prodname_copilot_short %} works in a sandbox development environment with internet access controlled by a firewall. It has read-only access to the repository it's assigned to work in.
|
||||
* **Limited access to branches**: {% data variables.product.prodname_copilot_short %} can only create and push to branches beginning with `copilot/`. It is subject to any branch protections and required checks for the working repository.
|
||||
@@ -133,7 +147,6 @@ Users can include hidden messages in issues assigned to {% data variables.produc
|
||||
* **{% data variables.product.prodname_copilot_short %} can only make changes in the same repository where it is creating its pull request**. When {% data variables.product.prodname_copilot_short %} is assigned an issue, it can only make changes in the repository where that issue is located. In addition, {% data variables.product.prodname_copilot_short %} cannot make changes across multiple repositories in one run.
|
||||
* **{% data variables.product.prodname_copilot_short %} can only access context in the same repository as the assigned issue**. By default, an integration with the {% data variables.product.prodname_copilot_short %} MCP server provides {% data variables.product.prodname_copilot_short %} access to one repository at a time. You can, however, configure broader access. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/extending-copilot-coding-agent-with-mcp).
|
||||
* **{% data variables.product.prodname_copilot_short %} can only open one pull request at a time**. {% data variables.product.prodname_copilot_short %} will open exactly one pull request to address each task it is assigned.
|
||||
* **{% data variables.product.prodname_copilot_short %} cannot work on an existing pull request that it didn't create**. If you would like {% data variables.product.prodname_copilot_short %} to provide feedback on an existing pull request, you can add it as a reviewer. See [AUTOTITLE](/copilot/using-github-copilot/code-review/using-copilot-code-review).
|
||||
|
||||
### Limitations in Copilot's compatibility with other features
|
||||
|
||||
@@ -153,4 +166,5 @@ Try the [Expand your team with {% data variables.copilot.copilot_coding_agent %}
|
||||
## Further reading
|
||||
|
||||
* [AUTOTITLE](/copilot/using-github-copilot/coding-agent) how-to articles
|
||||
* [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents)
|
||||
* [AUTOTITLE](/copilot/responsible-use-of-github-copilot-features/responsible-use-of-copilot-coding-agent-on-githubcom)
|
||||
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
title: About custom agents
|
||||
shortTitle: Custom agents
|
||||
intro: '{% data variables.copilot.custom_agents_caps_short %} enhance {% data variables.copilot.copilot_coding_agent %} with specialized assistance tailored to your needs.'
|
||||
product: '{% data reusables.gated-features.copilot-coding-agent %}<br><a href="https://github.com/features/copilot/plans?ref_product=copilot&ref_type=purchase&ref_style=button&utm_source=docs-signup-custom-agents&utm_medium=docs&utm_campaign=universe25" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Sign up for {% data variables.product.prodname_copilot_short %}</span> {% octicon "link-external" height:16 %}</a>'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
---
|
||||
|
||||
## About {% data variables.copilot.custom_agents_short %}
|
||||
|
||||
{% data variables.copilot.custom_agents_caps_short %} are specialized versions of {% data variables.copilot.copilot_coding_agent %} that you can tailor to your unique workflows, coding conventions, and use cases. Instead of repeatedly providing the same instructions and context, {% data variables.copilot.custom_agents_short %} allow you to define specialized agents that act like tailored teammates—following standards, using the right tools, and implementing team-specific practices.
|
||||
|
||||
{% data variables.copilot.custom_agents_caps_short %} are defined using Markdown files, called {% data variables.copilot.agent_profiles %}, that specify prompts, tools, and MCP servers. This allows individuals and teams to encode their conventions, frameworks, and desired outcomes directly into {% data variables.product.prodname_copilot_short %}. The {% data variables.copilot.agent_profile %} serves as the artifact that defines the custom agent's behavior, and assigning the agent to a task or issue instantiates the {% data variables.copilot.copilot_custom_agent_short %}.
|
||||
|
||||
## {% data variables.copilot.agent_profile_caps %} format
|
||||
|
||||
{% data variables.copilot.agent_profiles_caps %} are Markdown files with YAML frontmatter. In their simplest form, they include:
|
||||
|
||||
* **Name**: A unique identifier for the {% data variables.copilot.copilot_custom_agent_short %}
|
||||
* **Description**: Explains the agent's purpose and capabilities
|
||||
* **Prompt**: Custom instructions that define the agent's behavior and expertise
|
||||
* **Tools**: Specific tools the agent can access. This is optional, and the default is access to all available tools, including built-in tools and MCP server tools.
|
||||
|
||||
Organization and enterprise-level {% data variables.copilot.agent_profiles %} can also include MCP server configurations within the {% data variables.copilot.agent_profile %}, using the `mcp-server` property.
|
||||
|
||||
### Example {% data variables.copilot.agent_profile %}
|
||||
|
||||
This is a basic {% data variables.copilot.agent_profile %} with name, description, and prompt configured.
|
||||
|
||||
```text
|
||||
---
|
||||
name: readme-creator
|
||||
description: Agent specializing in creating and improving README files
|
||||
---
|
||||
|
||||
You are a documentation specialist focused on README files. Your scope is limited to README files or other related documentation files only - do not modify or analyze code files.
|
||||
|
||||
Focus on the following instructions:
|
||||
- Create and update README.md files with clear project descriptions
|
||||
- Structure README sections logically: overview, installation, usage, contributing
|
||||
- Write scannable content with proper headings and formatting
|
||||
- Add appropriate badges, links, and navigation elements
|
||||
- Use relative links (e.g., `docs/CONTRIBUTING.md`) instead of absolute URLs for files within the repository
|
||||
- Make links descriptive and add alt text to images
|
||||
```
|
||||
|
||||
## Where you can configure {% data variables.copilot.custom_agents_short %}
|
||||
|
||||
You can define {% data variables.copilot.agent_profiles %} at the repository level (`.github/agents/CUSTOM-AGENT-NAME.md` in your repository) for project-specific agents, or at the organization or enterprise level for broader availability. See [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-organization/prepare-for-custom-agents) and [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents).
|
||||
|
||||
## Where you can use {% data variables.copilot.custom_agents_short %}
|
||||
|
||||
Once created, your {% data variables.copilot.custom_agents_short %} are available wherever you can use {% data variables.copilot.copilot_coding_agent %}, including {% data variables.product.prodname_dotcom_the_website %} (the agents tab and panel, issue assignment, pull requests), the {% data variables.copilot.copilot_cli %}, and {% data variables.product.prodname_vscode %} (as chat modes). Each interaction maintains consistency based on the agent's defined profile, ensuring targeted support tailored to your specific needs.
|
||||
|
||||
{% data variables.copilot.agent_profiles_caps %} can be used directly in {% data variables.product.prodname_vscode %} as chat modes, though some properties may differ between the two environments. For more information on chat modes, see [Use chat modes in {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/docs/copilot/customization/custom-chat-modes?utm_source=docs-vscode-custom-agents&utm_medium=docs&utm_campaign=universe25).
|
||||
|
||||
## Next steps
|
||||
|
||||
To start creating your own {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-custom-agents).
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Managing access to GitHub Copilot coding agent
|
||||
shortTitle: Managing access
|
||||
shortTitle: Access management
|
||||
allowTitleToDifferFromFilename: true
|
||||
intro: Find out about {% data variables.copilot.copilot_coding_agent %} policies available for {% data variables.copilot.copilot_enterprise %} and {% data variables.copilot.copilot_for_business %}, and about disabling the agent for specific repositories.
|
||||
product: '{% data reusables.gated-features.copilot-coding-agent %}<br><a href="https://github.com/features/copilot/plans?ref_product=copilot&ref_type=engagement&ref_style=button" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Sign up for {% data variables.product.prodname_copilot_short %}</span> {% octicon "link-external" height:16 %}</a>'
|
||||
@@ -18,6 +18,7 @@ redirect_from:
|
||||
- /copilot/concepts/agents/coding-agent/enable-coding-agent
|
||||
- /copilot/how-tos/agents/copilot-coding-agent/enabling-copilot-coding-agent
|
||||
- /copilot/concepts/agents/coding-agent/coding-agent-for-business-and-enterprise
|
||||
- /copilot/concepts/agents/coding-agent/managing-access
|
||||
contentType: concepts
|
||||
---
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
title: About agent management
|
||||
shortTitle: Agent management
|
||||
intro: 'Use one centralized control page to jump between {% data variables.copilot.copilot_coding_agent %} sessions, check progress, and stay in control without losing your place.'
|
||||
product: '{% data reusables.gated-features.copilot-coding-agent %}<br><a href="https://github.com/features/copilot/plans?ref_product=copilot&ref_type=purchase&ref_style=button&utm_source=docs-signup-agent-management&utm_medium=docs&utm_campaign=universe25" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Sign up for {% data variables.product.prodname_copilot_short %}</span> {% octicon "link-external" height:16 %}</a>'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
redirect_from:
|
||||
- /copilot/concepts/agents/coding-agent/managing-agents
|
||||
contentType: concepts
|
||||
---
|
||||
|
||||
## About agents
|
||||
|
||||
AI agents are autonomous systems that can evaluate their environment, make decisions, and take actions to complete tasks. Agents can break down complex tasks into steps, use various tools and resources, plan their approach, and adapt based on human feedback until they accomplish their assigned objective.
|
||||
|
||||
{% data variables.copilot.copilot_coding_agent %} brings automation and assistance to every stage of the software development process on {% data variables.product.github %}. You can run multiple sessions of {% data variables.copilot.copilot_coding_agent %} concurrently, allowing you to efficiently delegate work items. Utilizing {% data variables.copilot.custom_agents_short %} you can build out a team of task-specific agents with customized system prompts to handle simpler tasks like writing tests and refactoring, giving you bandwidth to prioritize problem-solving and collaboration. See [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents).
|
||||
|
||||
To learn more about {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-coding-agent).
|
||||
|
||||
## Managing agents
|
||||
|
||||
{% data reusables.copilot.coding-agent.agent-management-intro %}
|
||||
|
||||
From the Agents tab, you can:
|
||||
|
||||
* **Kick off new agent tasks**: Select any repository you have write access to, and optionally choose from {% data variables.copilot.custom_agents_short %} best suited for the task. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/create-a-pr).
|
||||
* **Review the live session log, diff, and overview of changes**: Once {% data variables.product.prodname_copilot_short %} starts working, you can open the agent session to monitor agent activity.
|
||||
* **Steer agents mid-session**: If you realize you didn't scope a request correctly, or want {% data variables.product.prodname_copilot_short %} to use a specific tool or service, you can step in and provide **steering input** without stopping the run. Steering uses **one premium request** per message. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/track-copilot-sessions#steering-a-copilot-session-from-the-agents-tab).
|
||||
* **Open a session in {% data variables.product.prodname_vscode_shortname %}**: When you want to start working on changes to an agent session in your local development environment, click the "Open in {% data variables.product.prodname_vscode_shortname %} Insiders" button to open the session in {% data variables.product.prodname_vscode_shortname %}.
|
||||
{% data reusables.copilot.coding-agent.use-latest-vscode %}
|
||||
* **Review and merge agent code**: Once {% data variables.product.prodname_copilot_short %} completes a session, you can read a summary of the changes it made and scan the diff of the pull request to see if you want to request further improvements. If the changes look ready for a final review, you can jump right into the pull request from the agent session view to approve and merge. See [AUTOTITLE](/copilot/how-tos/use-copilot-agents/coding-agent/review-copilot-prs).
|
||||
|
||||
## Next steps
|
||||
|
||||
To start managing agents, see [AUTOTITLE](/copilot/how-tos/use-copilot-agents/manage-agents).
|
||||
@@ -9,7 +9,9 @@ topics:
|
||||
- Copilot
|
||||
children:
|
||||
- /about-coding-agent
|
||||
- /managing-access
|
||||
- /agent-management
|
||||
- /about-custom-agents
|
||||
- /access-management
|
||||
- /mcp-and-coding-agent
|
||||
contentType: concepts
|
||||
redirect_from:
|
||||
|
||||
@@ -42,6 +42,14 @@ Once MCP servers are configured for use within a repository, the tools specified
|
||||
|
||||
For details of how to set up MCP servers for {% data variables.copilot.copilot_coding_agent %} in a repository, see [AUTOTITLE](/copilot/how-tos/agents/copilot-coding-agent/extending-copilot-coding-agent-with-mcp).
|
||||
|
||||
## MCP servers for {% data variables.copilot.custom_agents_short %}
|
||||
|
||||
Organization and enterprise administrators can also configure MCP servers as part of {% data variables.copilot.custom_agents_short %}.
|
||||
|
||||
MCP servers configured in {% data variables.copilot.custom_agents_short %} are available only to that specific agent and follow the same processing order as other MCP configurations, with {% data variables.copilot.copilot_custom_agent_short %} MCP settings processed after default servers but before repository-level configurations.
|
||||
|
||||
For more information on configuring MCP servers for {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/reference/custom-agents-configuration#mcp-server-configuration-details).
|
||||
|
||||
## Best practices
|
||||
|
||||
* Enabling third-party MCP servers for use may impact the performance of the agent and the quality of the outputs. Review the third-party MCP server thoroughly and ensure that it meets your organization’s requirements.
|
||||
|
||||
39
content/copilot/concepts/agents/enterprise-management.md
Normal file
39
content/copilot/concepts/agents/enterprise-management.md
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
title: Agent management for enterprises
|
||||
shortTitle: Enterprise management
|
||||
intro: 'Maintain your enterprise''s security and compliance standards and supercharge your developers by managing agents with AI Controls.'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
contentType: concepts
|
||||
---
|
||||
|
||||
{% data reusables.enterprise-accounts.ai-controls-preview-note %}
|
||||
|
||||
## Overview
|
||||
|
||||
The AI Controls view provides a centralized platform where you can manage and monitor agents across your enterprise. From this agent control plane, you can:
|
||||
* Manage the enterprise-level availability of agents like {% data variables.copilot.copilot_coding_agent %}, {% data variables.copilot.copilot_code-review_short %}, and {% data variables.copilot.copilot_custom_agents %}
|
||||
* Control who can manage your enterprise-level {% data variables.copilot.custom_agents_short %}
|
||||
* View a list of agent sessions in your enterprise over the last 24 hours
|
||||
* Find a detailed record of agentic audit log events
|
||||
|
||||
## {% data variables.copilot.copilot_custom_agents %}
|
||||
|
||||
{% data variables.copilot.copilot_custom_agents %} are specialized versions of {% data variables.copilot.copilot_coding_agent %} that you can configure with tailored prompts, tools, and context, making them excel at specific tasks. {% data variables.copilot.custom_agents_caps_short %} can be defined and managed at the enterprise level for greater control and compliance, or at the organization and repository levels to allow teams the flexibility to build for their specific needs.
|
||||
|
||||
Before you start configuring agentic settings for your enterprise, you should have a strong understanding of {% data variables.copilot.custom_agents_short %}. To learn more, see [AUTOTITLE](/copilot/concepts/agents/coding-agent/about-custom-agents).
|
||||
|
||||
## Agent sessions
|
||||
|
||||
An agent session encompasses an entire interaction with {% data variables.copilot.copilot_coding_agent %}, or any individual {% data variables.copilot.copilot_custom_agent_short %}, on a specific task. These tasks include:
|
||||
|
||||
* Prompting the agent to create or edit a pull request
|
||||
* Assigning the agent to an issue
|
||||
|
||||
For billing information on agent sessions, see [AUTOTITLE](/billing/concepts/product-billing/github-copilot-premium-requests#usage-by-copilot-coding-agent).
|
||||
|
||||
## Next steps
|
||||
|
||||
To get started with {% data variables.copilot.custom_agents_short %}, see [AUTOTITLE](/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents).
|
||||
@@ -11,5 +11,7 @@ children:
|
||||
- /coding-agent
|
||||
- /code-review
|
||||
- /about-copilot-cli
|
||||
- /openai-codex
|
||||
- /enterprise-management
|
||||
contentType: concepts
|
||||
---
|
||||
|
||||
22
content/copilot/concepts/agents/openai-codex.md
Normal file
22
content/copilot/concepts/agents/openai-codex.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
title: OpenAI Codex
|
||||
shortTitle: OpenAI Codex
|
||||
allowTitleToDifferFromFilename: true
|
||||
intro: 'Use the {% data variables.product.prodname_openai_codex %} Visual Studio Code extension powered by {% data variables.product.prodname_copilot_short %}.'
|
||||
product: '{% data reusables.gated-features.openai-codex %}'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
contentType: concepts
|
||||
---
|
||||
|
||||
> [!NOTE] {% data variables.product.prodname_openai_codex %} integration is currently in {% data variables.release-phases.public_preview %}.
|
||||
|
||||
## Introduction
|
||||
|
||||
The {% data variables.product.prodname_openai_codex %} {% data variables.product.prodname_vscode_shortname %} extension can be powered by your existing {% data variables.product.prodname_copilot_short %} subscription. Use "Sign in with {% data variables.product.prodname_copilot_short %}" when launching the extension. {% data variables.product.prodname_copilot_short %} users can see this integration in the [Agent Sessions view](https://code.visualstudio.com/docs/copilot/chat/chat-sessions#_agent-sessions-view?ref_product=copilot&ref_type=engagement&ref_style=text&utm_source=docs-vscode-docs-copilot&utm_medium=docs&utm_campaign=universe25) in {% data variables.product.prodname_vscode_shortname %} Insiders along with progress on their running tasks. All usage is subect to GitHub rate limits and billing. See [AUTOTITLE](/copilot/concepts/billing/copilot-requests#premium-features).
|
||||
|
||||
## Model availability
|
||||
|
||||
A subset of available models may only be available in the OpenAI Codex extension. Model availability and visibility is not governed by {% data variables.product.prodname_copilot_short %} model configuration policies.
|
||||
Reference in New Issue
Block a user