[EDI 5516 - Builders] Update Copilot coding agent docs in light of EDI audit (#56721)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Sarita Iyer <66540150+saritai@users.noreply.github.com>
This commit is contained in:
hubwriter
@@ -13,6 +13,7 @@ redirect_from:
|
||||
- /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/about-assigning-issues-to-copilot
|
||||
- /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/about-assigning-tasks-to-copilot
|
||||
- /copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot
|
||||
- /copilot/concepts/about-copilot-coding-agent
|
||||
---
|
||||
|
||||
> [!NOTE]
|
||||
@@ -63,7 +64,7 @@ Having {% data variables.product.prodname_copilot_short %} as an additional codi
|
||||
|
||||
### Making {% data variables.copilot.copilot_coding_agent %} available
|
||||
|
||||
Before you can assign tasks to {% data variables.product.prodname_copilot_short %}, it must be enabled. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/enabling-copilot-coding-agent).
|
||||
Before you can assign tasks to {% data variables.product.prodname_copilot_short %}, it must be enabled. See [AUTOTITLE](/copilot/concepts/coding-agent/about-enabling-coding-agent).
|
||||
|
||||
## {% data variables.copilot.copilot_coding_agent %} usage costs
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
---
|
||||
title: Enabling Copilot coding agent
|
||||
shortTitle: Enable coding agent
|
||||
intro: 'You can allow {% data variables.product.prodname_copilot_short %} to work on code and raise pull requests.'
|
||||
title: 'About enabling {% data variables.copilot.copilot_coding_agent %}'
|
||||
shortTitle: 'Enabling {% data variables.copilot.copilot_coding_agent_short %}'
|
||||
allowTitleToDifferFromFilename: true
|
||||
intro: 'Find out about enabling {% data variables.copilot.copilot_coding_agent %} 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_cta=Copilot+plans+signup&ref_loc=enabling+copilot+coding+agent&ref_page=docs" 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
|
||||
type: how_to
|
||||
redirect_from:
|
||||
- /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/enabling-copilot-coding-agent
|
||||
- /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/enabling-copilot-coding-agent-for-your-personal-repositories
|
||||
@@ -26,7 +26,7 @@ redirect_from:
|
||||
|
||||
If you are a {% data variables.copilot.copilot_enterprise %} or {% data variables.copilot.copilot_for_business %} subscriber, {% data variables.copilot.copilot_coding_agent %} is disabled by default and must be enabled by an administrator before it is available for use.
|
||||
|
||||
If you are a {% data variables.copilot.copilot_pro_plus %} subscriber, {% data variables.copilot.copilot_coding_agent %} is enabled by default.
|
||||
If you are a {% data variables.copilot.copilot_pro %} or Pro+ subscriber, {% data variables.copilot.copilot_coding_agent %} is enabled by default.
|
||||
|
||||
Once enabled, you can use {% data variables.copilot.copilot_coding_agent %} in any repository, provided that an administrator hasn't opted the repository out.
|
||||
|
||||
16
content/copilot/concepts/coding-agent/index.md
Normal file
16
content/copilot/concepts/coding-agent/index.md
Normal file
@@ -0,0 +1,16 @@
|
||||
---
|
||||
title: 'Concepts for {% data variables.copilot.copilot_coding_agent %}'
|
||||
shortTitle: '{% data variables.copilot.copilot_coding_agent_short_cap_c %}'
|
||||
allowTitleToDifferFromFilename: true
|
||||
intro: 'Learn how {% data variables.copilot.copilot_coding_agent %} can carry out coding tasks for you, working independently in the same workflow you use yourself.'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
children:
|
||||
- /about-copilot-coding-agent
|
||||
- /about-enabling-coding-agent
|
||||
- /mcp-and-coding-agent
|
||||
---
|
||||
|
||||
These articles provide an overview of {% data variables.copilot.copilot_coding_agent %}. For instructions on configuring and using {% data variables.copilot.copilot_coding_agent %}, see the how-to articles under [AUTOTITLE](/copilot/how-tos/agents/copilot-coding-agent).
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
title: 'Model Context Protocol (MCP) and {% data variables.copilot.copilot_coding_agent %}'
|
||||
shortTitle: 'MCP and {% data variables.copilot.copilot_coding_agent_short %}'
|
||||
allowTitleToDifferFromFilename: true
|
||||
intro: 'Find out about using the Model Context Protocol (MCP) with {% data variables.copilot.copilot_coding_agent %}.'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
---
|
||||
|
||||
> [!NOTE]
|
||||
> {% data reusables.copilot.coding-agent.preview-note-text %}
|
||||
|
||||
## Overview
|
||||
|
||||
{% data reusables.copilot.coding-agent.mcp-brief-intro %}
|
||||
|
||||
The agent can use tools provided by local and remote MCP servers. Some MCP servers are configured by default to provide the best experience for getting started.
|
||||
|
||||
For more information on MCP, see [the official MCP documentation](https://modelcontextprotocol.io/introduction). For information on some of the currently available MCP servers, see [the MCP servers repository](https://github.com/modelcontextprotocol/servers/tree/main).
|
||||
|
||||
> [!NOTE]
|
||||
> * {% data variables.copilot.copilot_coding_agent %} only supports tools provided by MCP servers. It does not support resources or prompts.
|
||||
> * {% data variables.copilot.copilot_coding_agent %} does not currently support remote MCP servers that leverage OAuth for authentication and authorization.
|
||||
|
||||
## Default MCP servers
|
||||
|
||||
The following MCP servers are configured automatically for {% data variables.copilot.copilot_coding_agent %}:
|
||||
|
||||
* **{% data variables.product.github %}**: The {% data variables.product.github %} MCP server gives {% data variables.product.prodname_copilot_short %} access to {% data variables.product.github %} data like issues and pull requests. To learn more, see [AUTOTITLE](/copilot/customizing-copilot/using-model-context-protocol/using-the-github-mcp-server).
|
||||
* By default, the {% data variables.product.github %} MCP server connects to {% data variables.product.github %} using a specially scoped token that only has read-only access to the current repository. You can customize it to use a different token with broader access. For more details, see [AUTOTITLE](/copilot/how-tos/agents/copilot-coding-agent/extending-copilot-coding-agent-with-mcp#customizing-the-built-in-github-mcp-server).
|
||||
|
||||
* **Playwright**: The [Playwright MCP server](https://github.com/microsoft/playwright-mcp) gives {% data variables.product.prodname_copilot_short %} access to web pages, including the ability to read, interact and take screenshots.
|
||||
* By default, the Playwright MCP server is only able to access web resources hosted within {% data variables.product.prodname_copilot_short %}'s own environment, accessible on `localhost` or `127.0.0.1`.
|
||||
|
||||
## Setting up MCP servers in a repository
|
||||
|
||||
Repository administrators can configure MCP servers for use within that repository. This is done via a JSON-formatted configuration that specifies the details of the MCP servers that {% data variables.copilot.copilot_coding_agent %} can use.
|
||||
|
||||
Once MCP servers are configured for use within a repository, the tools specified in the configuration will be available to {% data variables.copilot.copilot_coding_agent %} during each assigned task.
|
||||
|
||||
{% data variables.product.prodname_copilot_short %} will use available tools autonomously, and will not ask for approval before use.
|
||||
|
||||
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).
|
||||
|
||||
## 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.
|
||||
|
||||
* By default, {% data variables.copilot.copilot_coding_agent %} does not have access to write MCP server tools. However, some MCP servers do contain such tools. Be sure to review the tools available in the MCP server you want to use. Update the `tools` field in the MCP configuration with only the necessary tooling.
|
||||
|
||||
* Carefully review the configured MCP servers prior to saving the configuration to ensure the correct servers are configured for use.
|
||||
@@ -10,9 +10,9 @@ children:
|
||||
- /copilot-billing
|
||||
- /choosing-the-right-ai-tool-for-your-task
|
||||
- /completions
|
||||
- /coding-agent
|
||||
- /prompt-engineering-for-copilot-chat
|
||||
- /about-customizing-github-copilot-chat-responses
|
||||
- /about-copilot-coding-agent
|
||||
- /code-review
|
||||
- /about-github-copilot-chat
|
||||
- /content-exclusion-for-github-copilot
|
||||
@@ -24,4 +24,3 @@ children:
|
||||
- /rate-limits
|
||||
- /network-settings-for-github-copilot
|
||||
---
|
||||
|
||||
|
||||
@@ -53,6 +53,6 @@ Once {% data variables.copilot.copilot_coding_agent %} is enabled for a reposito
|
||||
* Tell the members of repositories where {% data variables.copilot.copilot_coding_agent %} is available that they can delegate work to the coding agent.
|
||||
* Encourage members to educate themselves about setting up their repository to get the most from {% data variables.copilot.copilot_coding_agent %}. Useful resources:
|
||||
|
||||
* [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/best-practices-for-using-copilot-to-work-on-tasks)
|
||||
* [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices)
|
||||
* [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent)
|
||||
* [Security best practices](/copilot/rolling-out-github-copilot-at-scale/enabling-developers/using-copilot-coding-agent-in-org#security-best-practices)
|
||||
|
||||
@@ -135,5 +135,5 @@ You can view your current and past {% data variables.product.prodname_copilot_sh
|
||||
## Further reading
|
||||
|
||||
* [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent)
|
||||
* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks)
|
||||
* [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices)
|
||||
* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent#copilot-cant-create-a-pull-request-from-copilot-chat)
|
||||
|
||||
@@ -14,8 +14,6 @@ redirect_from:
|
||||
> [!NOTE]
|
||||
> {% data reusables.copilot.coding-agent.preview-note-text %}
|
||||
>
|
||||
> For an introduction to {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent).
|
||||
>
|
||||
> Firewall configuration has moved to the {% data variables.copilot.copilot_coding_agent %} settings page. Previous configurations saved as Actions variables will be maintained on that page.
|
||||
|
||||
## Overview
|
||||
|
||||
@@ -14,8 +14,6 @@ redirect_from:
|
||||
|
||||
> [!NOTE]
|
||||
> {% data reusables.copilot.coding-agent.preview-note-text %}
|
||||
>
|
||||
> For an introduction to {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent).
|
||||
|
||||
## About customizing {% data variables.copilot.copilot_coding_agent %}'s development environment
|
||||
|
||||
|
||||
@@ -17,43 +17,36 @@ redirect_from:
|
||||
|
||||
> [!NOTE]
|
||||
> {% data reusables.copilot.coding-agent.preview-note-text %}
|
||||
>
|
||||
> For an introduction to {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent).
|
||||
|
||||
## Overview
|
||||
## Prerequisite
|
||||
|
||||
{% data reusables.copilot.coding-agent.mcp-brief-intro %}
|
||||
Before setting up an MCP server for {% data variables.copilot.copilot_coding_agent %}, read [AUTOTITLE](/copilot/concepts/coding-agent/mcp-and-coding-agent) to make sure you understand the concepts around MCP servers and {% data variables.copilot.copilot_coding_agent %}.
|
||||
|
||||
The agent can use tools provided by local and remote MCP servers. Some MCP servers are configured by default to provide the best experience for getting started.
|
||||
## Introduction
|
||||
|
||||
For more information on MCP, see [the official MCP documentation](https://modelcontextprotocol.io/introduction). For information on some of the currently available MCP servers, see [the MCP servers repository](https://github.com/modelcontextprotocol/servers/tree/main).
|
||||
|
||||
> [!NOTE]
|
||||
> * {% data variables.copilot.copilot_coding_agent %} only supports tools provided by MCP servers. It does not support resources or prompts.
|
||||
> * {% data variables.copilot.copilot_coding_agent %} does not currently support remote MCP servers that leverage OAuth for authentication and authorization.
|
||||
|
||||
## Default MCP servers
|
||||
|
||||
The following MCP servers are configured automatically for {% data variables.copilot.copilot_coding_agent %}:
|
||||
|
||||
* **{% data variables.product.github %}**: The {% data variables.product.github %} MCP server gives {% data variables.product.prodname_copilot_short %} access to {% data variables.product.github %} data like issues and pull requests. To learn more, see [AUTOTITLE](/copilot/customizing-copilot/using-model-context-protocol/using-the-github-mcp-server).
|
||||
* By default, the {% data variables.product.github %} MCP server connects to {% data variables.product.github %} using a specially scoped token that only has read-only access to the current repository. You can customize it to use a different token with broader access. For more details, see [Customizing the built-in {% data variables.product.github %} MCP server](#customizing-the-built-in-github-mcp-server) below.
|
||||
|
||||
* **Playwright**: The [Playwright MCP server](https://github.com/microsoft/playwright-mcp) gives {% data variables.product.prodname_copilot_short %} access to web pages, including the ability to read, interact and take screenshots.
|
||||
* By default, the Playwright MCP server is only able to access web resources hosted within {% data variables.product.prodname_copilot_short %}'s own environment, accessible on `localhost` or `127.0.0.1`.
|
||||
|
||||
## Setting up MCP servers in a repository
|
||||
As a repository administrator, you can configure MCP servers for use within your repository. You do this using a JSON-formatted configuration that specifies the details of the MCP servers you want to use. You enter the JSON configuration directly into the settings for the repository on {% data variables.product.prodname_dotcom_the_website %}.
|
||||
|
||||
> [!WARNING]
|
||||
> Once you've configured an MCP server, {% data variables.product.prodname_copilot_short %} will be able to use the tools provided by the server autonomously, and will not ask for your approval before using them.
|
||||
|
||||
As a repository administrator, you can configure MCP servers for use within your repository. This is done via a JSON-formatted configuration that specifies the details of the MCP servers you want to use. You enter the JSON configuration directly into the settings for the repository on {% data variables.product.prodname_dotcom_the_website %}.
|
||||
## Adding an MCP configuration to your repository
|
||||
|
||||
Once MCP servers are configured for use within a repository, the tools specified in the configuration will be available to {% data variables.copilot.copilot_coding_agent %} during each assigned task.
|
||||
Repository administrators can configure MCP servers by following these steps:
|
||||
|
||||
{% data variables.product.prodname_copilot_short %} will use available tools autonomously, and will not ask for approval before use.
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
1. In the "Code & automation" section of the sidebar, click **{% data variables.product.prodname_copilot_short %}** then **{% data variables.copilot.copilot_coding_agent_short_cap_c %}**.
|
||||
1. Add your configuration in the **MCP configuration** section.
|
||||
|
||||
### Creating your JSON MCP configuration
|
||||
The following sections in this article explain how to write the JSON configuration that you need to enter here.
|
||||
|
||||
1. Click **Save**.
|
||||
|
||||
Your configuration will be validated to ensure proper syntax.
|
||||
|
||||
1. If your MCP server requires a key or secret, add a secret to your {% data variables.product.prodname_copilot_short %} environment. Only secrets with names prefixed with `COPILOT_MCP_` will be available to your MCP configuration. See [Setting up a {% data variables.product.prodname_copilot_short %} environment for {% data variables.copilot.copilot_coding_agent %}](#setting-up-a-copilot-environment-for-copilot-coding-agent).
|
||||
|
||||
## Writing a JSON configuration for MCP servers
|
||||
|
||||
You configure MCP servers using a special JSON format. The JSON must contain an `mcpServers` object, where the key is the name of the MCP server (for example, `sentry`), and the value is an object with the configuration for that MCP server.
|
||||
|
||||
@@ -94,9 +87,9 @@ The configuration object can contain the following keys:
|
||||
* The name of a {% data variables.product.prodname_actions %} secret you have configured, beginning with `COPILOT_MCP_` preceded by a `$`
|
||||
* A string value
|
||||
|
||||
### Example configurations
|
||||
## Example configurations
|
||||
|
||||
#### Example: Sentry
|
||||
### Example: Sentry
|
||||
|
||||
The [Sentry MCP server](https://github.com/getsentry/sentry-mcp) gives {% data variables.product.prodname_copilot_short %} authenticated access to exceptions recorded in [Sentry](https://sentry.io).
|
||||
|
||||
@@ -123,7 +116,7 @@ The [Sentry MCP server](https://github.com/getsentry/sentry-mcp) gives {% data v
|
||||
}
|
||||
```
|
||||
|
||||
#### Example: Notion
|
||||
### Example: Notion
|
||||
|
||||
The [Notion MCP server](https://github.com/makenotion/notion-mcp-server) gives {% data variables.product.prodname_copilot_short %} authenticated access to notes and other content from [Notion](https://notion.so).
|
||||
|
||||
@@ -155,7 +148,7 @@ The [Notion MCP server](https://github.com/makenotion/notion-mcp-server) gives {
|
||||
}
|
||||
```
|
||||
|
||||
#### Example: Azure
|
||||
### Example: Azure
|
||||
|
||||
The [Azure MCP server](https://github.com/Azure/azure-mcp) creates a seamless connection between {% data variables.product.prodname_copilot_short %} and key Azure services such as Azure Cosmos DB and the Azure Storage platform.
|
||||
|
||||
@@ -210,7 +203,7 @@ To use the Azure MCP with {% data variables.copilot.copilot_coding_agent %}, you
|
||||
}
|
||||
```
|
||||
|
||||
#### Example: Cloudflare
|
||||
### Example: Cloudflare
|
||||
|
||||
The [Cloudflare MCP server](https://github.com/cloudflare/mcp-server-cloudflare) creates connections between your Cloudflare services, including processing documentation and data analysis.
|
||||
|
||||
@@ -226,7 +219,7 @@ The [Cloudflare MCP server](https://github.com/cloudflare/mcp-server-cloudflare)
|
||||
}
|
||||
```
|
||||
|
||||
### Reusing your MCP configuration from {% data variables.product.prodname_vscode %}
|
||||
## Reusing your MCP configuration from {% data variables.product.prodname_vscode %}
|
||||
|
||||
If you have already configured MCP servers in {% data variables.product.prodname_vscode_shortname %}, you can leverage a similar configuration for {% data variables.copilot.copilot_coding_agent %}.
|
||||
|
||||
@@ -241,21 +234,7 @@ To adapt the configuration for {% data variables.copilot.copilot_coding_agent %}
|
||||
|
||||
For more information on MCP in {% data variables.product.prodname_vscode_shortname %}, see the [{% data variables.product.prodname_vscode_shortname %} docs](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
|
||||
|
||||
### Adding your configuration to your repository
|
||||
|
||||
Repository administrators can configure MCP servers by following these steps:
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
1. In the "Code & automation" section of the sidebar, click **{% data variables.product.prodname_copilot_short %}** then **{% data variables.copilot.copilot_coding_agent_short %}**.
|
||||
1. Add your configuration in the **MCP configuration** section.
|
||||
1. Click **Save**.
|
||||
|
||||
Your configuration will be validated to ensure proper syntax.
|
||||
|
||||
1. If your MCP server requires a key or secret, add a secret to your {% data variables.product.prodname_copilot_short %} environment. Only secrets with names prefixed with `COPILOT_MCP_` will be available to your MCP configuration. See [Setting up a {% data variables.product.prodname_copilot_short %} environment for {% data variables.copilot.copilot_coding_agent %}](#setting-up-a-copilot-environment-for-copilot-coding-agent).
|
||||
|
||||
### Setting up a {% data variables.product.prodname_copilot_short %} environment for {% data variables.copilot.copilot_coding_agent %}
|
||||
## Setting up a {% data variables.product.prodname_copilot_short %} environment for {% data variables.copilot.copilot_coding_agent %}
|
||||
|
||||
Some MCP servers will require keys or secrets. To leverage those servers in {% data variables.copilot.copilot_coding_agent %}, you can add secrets to an environment for {% data variables.product.prodname_copilot_short %}. This ensures the secrets are properly recognized and passed to the applicable MCP server that you have configured.
|
||||
|
||||
@@ -269,7 +248,7 @@ You must be a repository administrator to configure a {% data variables.product.
|
||||
1. Under "Environment secrets", click **Add environment secret**.
|
||||
1. Give the secret a name beginning `COPILOT_MCP_`, add the secret value, then click **Add secret**.
|
||||
|
||||
### Validating your MCP configuration
|
||||
## Validating your MCP configuration
|
||||
|
||||
Once you've set up your MCP configuration, you should test it to make sure it is set up correctly.
|
||||
|
||||
@@ -293,7 +272,7 @@ If you want to allow {% data variables.product.prodname_copilot_short %} to acce
|
||||
1. Create a {% data variables.product.pat_generic %} with the appropriate permissions. We recommend using a {% data variables.product.pat_v2 %}, where you can limit the token's access to read-only permissions on specific repositories. For more information on {% data variables.product.pat_generic_plural %}, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
1. In the "Code & automation" section of the sidebar, click **{% data variables.product.prodname_copilot_short %}** then **{% data variables.copilot.copilot_coding_agent_short %}**.
|
||||
1. In the "Code & automation" section of the sidebar, click **{% data variables.product.prodname_copilot_short %}** then **{% data variables.copilot.copilot_coding_agent_short_cap_c %}**.
|
||||
1. Add your configuration in the **MCP configuration** section.
|
||||
1. Click **Save**.
|
||||
{% data reusables.actions.sidebar-environment %}
|
||||
@@ -303,15 +282,7 @@ If you want to allow {% data variables.product.prodname_copilot_short %} to acce
|
||||
|
||||
For information on using the {% data variables.product.github %} MCP server in other environments, see [AUTOTITLE](/copilot/customizing-copilot/using-model-context-protocol/using-the-github-mcp-server).
|
||||
|
||||
## 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.
|
||||
|
||||
* By default, {% data variables.copilot.copilot_coding_agent %} does not have access to write MCP server tools. However, some MCP servers do contain such tools. Be sure to review the tools available in the MCP server you want to use. Update the `tools` field in the MCP configuration with only the necessary tooling.
|
||||
|
||||
* Carefully review the configured MCP servers prior to saving the configuration to ensure the correct servers are configured for use.
|
||||
|
||||
## Further reading
|
||||
## Next steps
|
||||
|
||||
* [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent)
|
||||
* [AUTOTITLE](/copilot/customizing-copilot/extending-copilot-chat-with-mcp)
|
||||
|
||||
@@ -1,14 +1,12 @@
|
||||
---
|
||||
title: Coding agent
|
||||
shortTitle: Use coding agent
|
||||
title: '{% data variables.copilot.copilot_coding_agent %}'
|
||||
shortTitle: '{% data variables.copilot.copilot_coding_agent_short_cap_c %}'
|
||||
intro: 'Find out how {% data variables.product.prodname_copilot_short %} can work on {% data variables.product.github %} issues and raise pull requests for your to review.'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
children:
|
||||
- /best-practices-for-using-copilot-to-work-on-tasks
|
||||
- /enabling-copilot-coding-agent
|
||||
- /asking-copilot-to-create-a-pull-request
|
||||
- /using-copilot-to-work-on-an-issue
|
||||
- /tracking-copilots-sessions
|
||||
@@ -24,4 +22,4 @@ redirect_from:
|
||||
- /copilot/using-github-copilot/coding-agent
|
||||
---
|
||||
|
||||
For an introduction to {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent).
|
||||
These articles provide how-to information for using {% data variables.copilot.copilot_coding_agent %}. For an overview of {% data variables.copilot.copilot_coding_agent %}, see the articles under [AUTOTITLE](/copilot/concepts/coding-agent).
|
||||
|
||||
@@ -43,7 +43,7 @@ If {% data variables.product.prodname_copilot_short %} starts a new agent sessio
|
||||
> [!TIP]
|
||||
> If you don't want {% data variables.product.prodname_copilot_short %} to respond to comments on a pull request, you can unassign {% data variables.product.prodname_copilot_short %} from the pull request. If you later reassign {% data variables.product.prodname_copilot_short %} to the same pull request it will respond to new comments and push more changes. It will not respond to comments that were added while it was not assigned.
|
||||
|
||||
For more information, see the section "Use comments to iterate on a pull request" in [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks#using-comments-to-iterate-on-a-pull-request).
|
||||
For more information, see the section "Use comments to iterate on a pull request" in [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices#using-comments-to-iterate-on-a-pull-request).
|
||||
|
||||
## Managing {% data variables.product.prodname_actions %} workflow runs
|
||||
|
||||
@@ -64,6 +64,6 @@ You can provide feedback on {% data variables.product.prodname_copilot_short %}'
|
||||
|
||||
## Further reading
|
||||
|
||||
* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks)
|
||||
* [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices)
|
||||
* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/using-the-copilot-coding-agent-logs)
|
||||
* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent)
|
||||
|
||||
@@ -16,8 +16,6 @@ redirect_from:
|
||||
|
||||
> [!NOTE]
|
||||
> {% data reusables.copilot.coding-agent.preview-note-text %}
|
||||
>
|
||||
> For an overview of {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent).
|
||||
|
||||
## Introduction
|
||||
|
||||
@@ -78,5 +76,5 @@ Reasons you might want to stop a session include:
|
||||
|
||||
## Further reading
|
||||
|
||||
* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks)
|
||||
* [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices)
|
||||
* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent)
|
||||
|
||||
@@ -17,8 +17,6 @@ redirect_from:
|
||||
|
||||
> [!NOTE]
|
||||
> {% data reusables.copilot.coding-agent.preview-note-text %}
|
||||
>
|
||||
> For an introduction to {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent).
|
||||
|
||||
## {% data variables.product.prodname_copilot_short %} is not available in the "Assignees" list on my issue
|
||||
|
||||
@@ -93,7 +91,7 @@ To allow {% data variables.product.prodname_actions %} workflows to run, click t
|
||||
|
||||
While working on an issue, {% data variables.product.prodname_copilot_short %} has access to its own ephemeral development environment, powered by {% data variables.product.prodname_actions %}, where it can execute automated tests and linters to validate its work before it pushes.
|
||||
|
||||
It is most likely to do this if given clear instructions on what to do. The best way to do this is with a `.github/copilot-instructions.md` file. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks#adding-custom-instructions-to-your-repository).
|
||||
It is most likely to do this if given clear instructions on what to do. The best way to do this is with a `.github/copilot-instructions.md` file. See [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices#adding-custom-instructions-to-your-repository).
|
||||
|
||||
## There is a warning from {% data variables.product.prodname_copilot %} about the firewall
|
||||
|
||||
@@ -109,5 +107,5 @@ For more information, see [AUTOTITLE](/copilot/customizing-copilot/customizing-o
|
||||
|
||||
## Further reading
|
||||
|
||||
* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks)
|
||||
* [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices)
|
||||
* [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent)
|
||||
|
||||
@@ -24,7 +24,7 @@ redirect_from:
|
||||
|
||||
You can assign a {% data variables.product.github %} issue to {% data variables.product.prodname_copilot_short %}, just like you would with a human software developer. {% data variables.product.prodname_copilot_short %} will start working on the issue, raise a pull request and when it's finished working, request a review from you. For more information, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent).
|
||||
|
||||
If you haven't used {% data variables.product.prodname_copilot_short %} to work on an issue before, you can find some useful advice for getting good results in [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks).
|
||||
If you haven't used {% data variables.product.prodname_copilot_short %} to work on an issue before, you can find some useful advice for getting good results in [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices).
|
||||
|
||||
## Assigning an issue to {% data variables.product.prodname_copilot_short %}
|
||||
|
||||
@@ -212,5 +212,5 @@ After {% data variables.product.prodname_copilot_short %} has finished working o
|
||||
|
||||
## Further reading
|
||||
|
||||
* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks)
|
||||
* [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices)
|
||||
* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent)
|
||||
|
||||
@@ -75,7 +75,7 @@ Each draft appears separately, and you can review and edit them individually. To
|
||||
|
||||
## Assigning issues to {% data variables.product.prodname_copilot_short %}
|
||||
|
||||
To assign an issue to {% data variables.product.prodname_copilot_short %}, you need to have {% data variables.copilot.copilot_coding_agent %} enabled. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/enabling-copilot-coding-agent).
|
||||
To assign an issue to {% data variables.product.prodname_copilot_short %}, you need to have {% data variables.copilot.copilot_coding_agent %} enabled. See [AUTOTITLE](/copilot/concepts/coding-agent/about-enabling-coding-agent).
|
||||
|
||||
You can assign the issue during creation in one of two ways:
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ featuredLinks:
|
||||
- /copilot/get-started/what-is-github-copilot
|
||||
- /copilot/get-started/quickstart
|
||||
- /copilot/tutorials/quickstart-for-github-copilot-extensions-using-agents
|
||||
- /copilot/concepts/about-copilot-coding-agent
|
||||
- /copilot/concepts/coding-agent/about-copilot-coding-agent
|
||||
popular:
|
||||
- /copilot/get-started/github-copilot-features
|
||||
- /copilot/tutorials/copilot-chat-cookbook
|
||||
@@ -35,4 +35,3 @@ children:
|
||||
topics:
|
||||
- Copilot
|
||||
---
|
||||
|
||||
|
||||
@@ -73,7 +73,7 @@ For more information about limitations, see [Limitations of {% data variables.co
|
||||
|
||||
### Customize your experience with additional context
|
||||
|
||||
{% data variables.copilot.copilot_coding_agent %} leverages your prompt, comments and the repository’s code as context when generating suggested changes. To enhance Copilot’s performance, consider implementing custom Copilot instructions to help the agent better understand your project and how to build, test and validate its changes. For more information, see the "Add custom instructions to your repository" in [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks#adding-custom-instructions-to-your-repository).
|
||||
{% data variables.copilot.copilot_coding_agent %} leverages your prompt, comments and the repository’s code as context when generating suggested changes. To enhance Copilot’s performance, consider implementing custom Copilot instructions to help the agent better understand your project and how to build, test and validate its changes. For more information, see "Add custom instructions to your repository" in [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices#adding-custom-instructions-to-your-repository).
|
||||
|
||||
For information about other customizations for {% data variables.copilot.copilot_coding_agent %}, see:
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Best practices for using Copilot to work on tasks
|
||||
shortTitle: Get the best results
|
||||
allowTitleToDifferFromFilename: true
|
||||
intro: 'Learn how to get the best results from {% data variables.copilot.copilot_coding_agent %}.'
|
||||
product: '{% data reusables.gated-features.copilot-coding-agent %}<br><a href="https://github.com/features/copilot/plans?ref_cta=Copilot+plans+signup&ref_loc=best+practices+for+using+copilot+to+work+on+tasks&ref_page=docs" 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:
|
||||
@@ -14,6 +15,7 @@ redirect_from:
|
||||
- /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/best-practices-for-using-copilot-to-work-on-tasks
|
||||
- /early-access/copilot/coding-agent/best-practices-for-using-copilot-coding-agent
|
||||
- /copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks
|
||||
- /copilot/how-tos/agents/copilot-coding-agent/best-practices-for-using-copilot-to-work-on-tasks
|
||||
---
|
||||
|
||||
> [!NOTE]
|
||||
13
content/copilot/tutorials/coding-agent/index.md
Normal file
13
content/copilot/tutorials/coding-agent/index.md
Normal file
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: '{% data variables.copilot.copilot_coding_agent %}'
|
||||
shortTitle: Coding agent
|
||||
allowTitleToDifferFromFilename: true
|
||||
intro: 'Find out how to get great results from {% data variables.copilot.copilot_coding_agent %}.'
|
||||
versions:
|
||||
feature: copilot
|
||||
topics:
|
||||
- Copilot
|
||||
children:
|
||||
- /best-practices
|
||||
- /pilot-coding-agent
|
||||
---
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Piloting Copilot coding agent in your organization
|
||||
shortTitle: Pilot coding agent
|
||||
title: 'Piloting {% data variables.copilot.copilot_coding_agent %} in your organization'
|
||||
shortTitle: 'Pilot {% data variables.copilot.copilot_coding_agent_short %}'
|
||||
intro: 'Follow best practices to enable {% data variables.copilot.copilot_coding_agent %} in your organization.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
versions:
|
||||
@@ -11,6 +11,7 @@ product: '{% data reusables.gated-features.copilot-coding-agent %}'
|
||||
redirect_from:
|
||||
- /copilot/rolling-out-github-copilot-at-scale/enabling-developers/using-copilot-coding-agent-in-org
|
||||
- /copilot/tutorials/rolling-out-github-copilot-at-scale/enabling-developers/using-copilot-coding-agent-in-org
|
||||
- /copilot/tutorials/pilot-copilot-coding-agent
|
||||
---
|
||||
<!--JTBD: When rolling out {% data variables.copilot.copilot_coding_agent %}, I want to understand use cases and follow best practices, so I can ensure I'm using it as intended and get value from a pilot program.-->
|
||||
|
||||
@@ -29,7 +30,7 @@ redirect_from:
|
||||
Before enabling {% data variables.copilot.copilot_coding_agent %} for members, understand how {% data variables.copilot.copilot_coding_agent %} will fit into your organization. This will help you evaluate whether {% data variables.copilot.copilot_coding_agent %} is suitable for your needs and plan communications and training sessions for developers.
|
||||
|
||||
1. Learn about {% data variables.copilot.copilot_coding_agent %}, including the costs, built-in security features, and how it differs from other AI tools your developers may be used to. See [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent).
|
||||
1. Learn about the tasks that {% data variables.copilot.copilot_coding_agent %} is best suited for. These are generally well-defined and scoped issues, such as increasing test coverage, fixing bugs or flaky tests, or updating config files or documentation. See [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks).
|
||||
1. Learn about the tasks that {% data variables.copilot.copilot_coding_agent %} is best suited for. These are generally well-defined and scoped issues, such as increasing test coverage, fixing bugs or flaky tests, or updating config files or documentation. See [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices).
|
||||
1. Consider how {% data variables.copilot.copilot_coding_agent %} fits alongside other tools in your organization's workflows. For an example scenario that walks through how to use {% data variables.copilot.copilot_coding_agent %} alongside other AI features on {% data variables.product.github %}, see [AUTOTITLE](/copilot/rolling-out-github-copilot-at-scale/enabling-developers/integrating-agentic-ai).
|
||||
|
||||
## 2. Secure
|
||||
@@ -54,7 +55,7 @@ As with any other change to working practices, it's important to run a trial to
|
||||
1. Choose an isolated or low-risk repository, for example, one that contains documentation or internal tools. You could create a fresh repository to use as a playground, but {% data variables.product.prodname_copilot_short %} needs context to be successful, so you would need to add a lot of context, including team processes, development environment, and common dependencies.
|
||||
1. Enable {% data variables.copilot.copilot_coding_agent %} in the repository and optionally enable third-party MCP servers for enhanced context sharing. See [AUTOTITLE](/copilot/managing-copilot/managing-github-copilot-in-your-organization/adding-copilot-coding-agent-to-organization).
|
||||
1. Create repository instructions and pre-install any tools required in the development environment {% data variables.product.prodname_copilot_short %} uses. See [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent).
|
||||
1. Identify a few compelling use cases for your organization, for example: test coverage or improving accessibility. See [Choose the right type of tasks to give to Copilot](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks#choosing-the-right-type-of-tasks-to-give-to-copilot) in the best practice guide.
|
||||
1. Identify a few compelling use cases for your organization, for example: test coverage or improving accessibility. See [Choose the right type of tasks to give to Copilot](/copilot/tutorials/coding-agent/best-practices#choosing-the-right-type-of-tasks-to-give-to-copilot) in the best practice guide.
|
||||
1. Use best practice to create or refine issues for {% data variables.product.prodname_copilot_short %} in your pilot repository.
|
||||
1. Assign issues to {% data variables.product.prodname_copilot_short %} and prepare team members to review its work.
|
||||
1. Spend time looking at the codebase or documentation in {% data variables.product.prodname_vscode_shortname %} or {% data variables.product.prodname_dotcom_the_website %}, asking {% data variables.product.prodname_copilot_short %} to create a pull request to fix any bugs or small improvements that you identify.
|
||||
@@ -8,6 +8,7 @@ topics:
|
||||
- Copilot
|
||||
children:
|
||||
- /copilot-chat-cookbook
|
||||
- /coding-agent
|
||||
- /comparing-ai-models-using-different-tasks
|
||||
- /enhancing-copilot-agent-mode-with-mcp
|
||||
- /quickstart-for-github-copilot-extensions-using-agents
|
||||
@@ -23,9 +24,7 @@ children:
|
||||
- /modernizing-legacy-code-with-github-copilot
|
||||
- /using-copilot-to-migrate-a-project
|
||||
- /upgrading-projects-with-github-copilot
|
||||
- /pilot-copilot-coding-agent
|
||||
- /rolling-out-github-copilot-at-scale
|
||||
redirect_from:
|
||||
- /copilot/using-github-copilot/guides-on-using-github-copilot
|
||||
---
|
||||
|
||||
|
||||
@@ -45,7 +45,8 @@ copilot_code-review_short: 'Copilot code review'
|
||||
|
||||
## Copilot coding agent (previously Padawan) -> {% data variables.copilot.copilot_coding_agent %}
|
||||
copilot_coding_agent: 'Copilot coding agent'
|
||||
copilot_coding_agent_short: 'Coding agent'
|
||||
copilot_coding_agent_short: 'coding agent'
|
||||
copilot_coding_agent_short_cap_c: 'Coding agent'
|
||||
|
||||
## Short for "Copilot Extensions agent" -> {% data variables.copilot.copilot_agent_short %}
|
||||
## Note: this is NOT a short form for the Copilot coding agent (previously Padawan):
|
||||
|
||||
Reference in New Issue
Block a user