Skip to content

Commit eb23007

Browse files
hubwriterCopilotsaritai
authored
[EDI 5516 - Builders] Update Copilot coding agent docs in light of EDI audit (#56721)
Co-authored-by: Copilot <[email protected]> Co-authored-by: Sarita Iyer <[email protected]>
1 parent a709705 commit eb23007

23 files changed

+142
-97
lines changed

content/copilot/concepts/about-copilot-coding-agent.md renamed to content/copilot/concepts/coding-agent/about-copilot-coding-agent.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ redirect_from:
1313
- /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/about-assigning-issues-to-copilot
1414
- /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/about-assigning-tasks-to-copilot
1515
- /copilot/using-github-copilot/coding-agent/about-assigning-tasks-to-copilot
16+
- /copilot/concepts/about-copilot-coding-agent
1617
---
1718

1819
> [!NOTE]
@@ -63,7 +64,7 @@ Having {% data variables.product.prodname_copilot_short %} as an additional codi
6364

6465
### Making {% data variables.copilot.copilot_coding_agent %} available
6566

66-
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).
67+
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).
6768

6869
## {% data variables.copilot.copilot_coding_agent %} usage costs
6970

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
2-
title: Enabling Copilot coding agent
3-
shortTitle: Enable coding agent
4-
intro: 'You can allow {% data variables.product.prodname_copilot_short %} to work on code and raise pull requests.'
2+
title: 'About enabling {% data variables.copilot.copilot_coding_agent %}'
3+
shortTitle: 'Enabling {% data variables.copilot.copilot_coding_agent_short %}'
4+
allowTitleToDifferFromFilename: true
5+
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.'
56
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>'
67
versions:
78
feature: copilot
89
topics:
910
- Copilot
10-
type: how_to
1111
redirect_from:
1212
- /copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-tasks/enabling-copilot-coding-agent
1313
- /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:
2626

2727
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.
2828

29-
If you are a {% data variables.copilot.copilot_pro_plus %} subscriber, {% data variables.copilot.copilot_coding_agent %} is enabled by default.
29+
If you are a {% data variables.copilot.copilot_pro %} or Pro+ subscriber, {% data variables.copilot.copilot_coding_agent %} is enabled by default.
3030

3131
Once enabled, you can use {% data variables.copilot.copilot_coding_agent %} in any repository, provided that an administrator hasn't opted the repository out.
3232

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: 'Concepts for {% data variables.copilot.copilot_coding_agent %}'
3+
shortTitle: '{% data variables.copilot.copilot_coding_agent_short_cap_c %}'
4+
allowTitleToDifferFromFilename: true
5+
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.'
6+
versions:
7+
feature: copilot
8+
topics:
9+
- Copilot
10+
children:
11+
- /about-copilot-coding-agent
12+
- /about-enabling-coding-agent
13+
- /mcp-and-coding-agent
14+
---
15+
16+
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).
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: 'Model Context Protocol (MCP) and {% data variables.copilot.copilot_coding_agent %}'
3+
shortTitle: 'MCP and {% data variables.copilot.copilot_coding_agent_short %}'
4+
allowTitleToDifferFromFilename: true
5+
intro: 'Find out about using the Model Context Protocol (MCP) with {% data variables.copilot.copilot_coding_agent %}.'
6+
versions:
7+
feature: copilot
8+
topics:
9+
- Copilot
10+
---
11+
12+
> [!NOTE]
13+
> {% data reusables.copilot.coding-agent.preview-note-text %}
14+
15+
## Overview
16+
17+
{% data reusables.copilot.coding-agent.mcp-brief-intro %}
18+
19+
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.
20+
21+
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).
22+
23+
> [!NOTE]
24+
> * {% data variables.copilot.copilot_coding_agent %} only supports tools provided by MCP servers. It does not support resources or prompts.
25+
> * {% data variables.copilot.copilot_coding_agent %} does not currently support remote MCP servers that leverage OAuth for authentication and authorization.
26+
27+
## Default MCP servers
28+
29+
The following MCP servers are configured automatically for {% data variables.copilot.copilot_coding_agent %}:
30+
31+
* **{% 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).
32+
* 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).
33+
34+
* **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.
35+
* 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`.
36+
37+
## Setting up MCP servers in a repository
38+
39+
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.
40+
41+
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.
42+
43+
{% data variables.product.prodname_copilot_short %} will use available tools autonomously, and will not ask for approval before use.
44+
45+
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).
46+
47+
## Best practices
48+
49+
* 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.
50+
51+
* 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.
52+
53+
* Carefully review the configured MCP servers prior to saving the configuration to ensure the correct servers are configured for use.

content/copilot/concepts/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ children:
1010
- /copilot-billing
1111
- /choosing-the-right-ai-tool-for-your-task
1212
- /completions
13+
- /coding-agent
1314
- /prompt-engineering-for-copilot-chat
1415
- /about-customizing-github-copilot-chat-responses
15-
- /about-copilot-coding-agent
1616
- /code-review
1717
- /about-github-copilot-chat
1818
- /content-exclusion-for-github-copilot
@@ -24,4 +24,3 @@ children:
2424
- /rate-limits
2525
- /network-settings-for-github-copilot
2626
---
27-

content/copilot/how-tos/administer/organizations/adding-copilot-coding-agent-to-organization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,6 @@ Once {% data variables.copilot.copilot_coding_agent %} is enabled for a reposito
5353
* Tell the members of repositories where {% data variables.copilot.copilot_coding_agent %} is available that they can delegate work to the coding agent.
5454
* Encourage members to educate themselves about setting up their repository to get the most from {% data variables.copilot.copilot_coding_agent %}. Useful resources:
5555

56-
* [AUTOTITLE](/copilot/using-github-copilot/using-copilot-coding-agent-to-work-on-issues/best-practices-for-using-copilot-to-work-on-tasks)
56+
* [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices)
5757
* [AUTOTITLE](/copilot/customizing-copilot/customizing-the-development-environment-for-copilot-coding-agent)
5858
* [Security best practices](/copilot/rolling-out-github-copilot-at-scale/enabling-developers/using-copilot-coding-agent-in-org#security-best-practices)

content/copilot/how-tos/agents/copilot-coding-agent/asking-copilot-to-create-a-pull-request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -135,5 +135,5 @@ You can view your current and past {% data variables.product.prodname_copilot_sh
135135
## Further reading
136136

137137
* [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent)
138-
* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks)
138+
* [AUTOTITLE](/copilot/tutorials/coding-agent/best-practices)
139139
* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/troubleshooting-copilot-coding-agent#copilot-cant-create-a-pull-request-from-copilot-chat)

content/copilot/how-tos/agents/copilot-coding-agent/customizing-or-disabling-the-firewall-for-copilot-coding-agent.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ redirect_from:
1414
> [!NOTE]
1515
> {% data reusables.copilot.coding-agent.preview-note-text %}
1616
>
17-
> For an introduction to {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent).
18-
>
1917
> 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.
2018
2119
## Overview

content/copilot/how-tos/agents/copilot-coding-agent/customizing-the-development-environment-for-copilot-coding-agent.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ redirect_from:
1414

1515
> [!NOTE]
1616
> {% data reusables.copilot.coding-agent.preview-note-text %}
17-
>
18-
> For an introduction to {% data variables.copilot.copilot_coding_agent %}, see [AUTOTITLE](/copilot/concepts/about-copilot-coding-agent).
1917
2018
## About customizing {% data variables.copilot.copilot_coding_agent %}'s development environment
2119

0 commit comments

Comments
 (0)