6cb52958e6
Co-authored-by: Sarah Schneider <sarahs@github.com> Co-authored-by: Sarah Schneider <sarahs@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
569 lines
38 KiB
Markdown
569 lines
38 KiB
Markdown
---
|
|
title: Using the GitHub MCP Server
|
|
intro: 'Learn how to use the GitHub Model Context Protocol (MCP) server to extend {% data variables.copilot.copilot_chat_short %}.'
|
|
shortTitle: Use the GitHub MCP Server
|
|
versions:
|
|
feature: copilot
|
|
defaultTool: vscode
|
|
topics:
|
|
- Copilot
|
|
redirect_from:
|
|
- /copilot/customizing-copilot/using-model-context-protocol/using-the-github-mcp-server
|
|
- /copilot/how-tos/context/model-context-protocol/using-the-github-mcp-server
|
|
- /copilot/how-tos/context/model-context-protocol/use-the-github-mcp-server
|
|
- /copilot/how-tos/context/use-mcp/use-the-github-mcp-server
|
|
contentType: how-tos
|
|
---
|
|
|
|
The {% data variables.product.github %} MCP server is available to all {% data variables.product.github %} users regardless of plan type. However, specific tools within the MCP server inherit the same access requirements as their corresponding {% data variables.product.github %} features. If a feature requires a paid {% data variables.product.github %} or {% data variables.product.prodname_copilot_short %} license, the equivalent MCP tool will require the same subscription. For example, tools that interact with {% data variables.product.prodname_copilot_short %} Coding Agent require a paid {% data variables.product.prodname_copilot_short %} license.
|
|
|
|
{% vscode %}
|
|
|
|
{% data reusables.copilot.mcp.about-github-mcp-server %}
|
|
|
|
## Prerequisites
|
|
|
|
* A {% data variables.product.github %} account.
|
|
* {% data variables.product.prodname_vscode %}, or another MCP-compatible editor.
|
|
* {% data reusables.copilot.mcp-policy-requirement %}
|
|
|
|
## Setting up the {% data variables.product.github %} MCP server in {% data variables.product.prodname_vscode %}
|
|
|
|
The instructions below guide you through setting up the {% data variables.product.github %} MCP server in {% data variables.product.prodname_vscode %}. Other MCP-compatible editors may have similar steps, but the exact process may vary.
|
|
|
|
You can choose to set up the {% data variables.product.github %} MCP server either remotely or locally, depending on your needs and preferences. You can also configure your {% data variables.product.github %} MCP server for either:
|
|
|
|
{% data reusables.copilot.mcp.mcp-configuration-location %}
|
|
|
|
The remote {% data variables.product.github %} MCP server uses one-click OAuth authentication by default, but you can also manually configure it to use a {% data variables.product.pat_generic %} (PAT) for authentication. If you use OAuth, the MCP server can only access the scopes you approve during sign-in. In organization-owned contexts, access may also be limited by admin policies that control which scopes and apps are permitted. If you use a PAT, the MCP server will have access to the scopes granted by the PAT, which is also subject to any PAT restrictions configured by the organization.
|
|
|
|
If you are an {% data variables.product.prodname_emu %}, then PAT is disabled by default, unless enabled by an enterprise administrator. If PAT is disabled, you won't be able to use PAT authentication. If you have OAuth access policy restrictions, you will need the OAuth App for each client (MCP host application) to be enabled (except {% data variables.product.prodname_vscode %} and {% data variables.product.prodname_vs %} since they are first-party Microsoft IDEs with native {% data variables.product.prodname_copilot_short %} integration).
|
|
|
|
* [Remote MCP server configuration with OAuth](#remote-mcp-server-configuration-with-oauth)
|
|
* [Remote MCP server configuration with PAT](#remote-mcp-server-configuration-with-pat)
|
|
* [Local MCP server setup](#local-mcp-server-setup)
|
|
|
|
### Remote MCP server configuration with OAuth
|
|
|
|
> [!NOTE]
|
|
> The remote {% data variables.product.github %} MCP server is not available to {% data variables.product.prodname_ghe_server %} users. If you are using {% data variables.product.prodname_ghe_server %}, you can install the {% data variables.product.github %} MCP server locally. See [Local MCP server setup](#local-mcp-server-setup).
|
|
|
|
You do not need to create a PAT or install any additional software to use the remote {% data variables.product.github %} MCP server with OAuth. You can set it up directly in {% data variables.product.prodname_vscode %}. You can also install individual toolsets, either in read-only mode or with full read/write access, allowing you to tailor the server's capabilities to your specific needs. For more information, see [Tool configuration](#tool-configuration).
|
|
|
|
1. In {% data variables.product.prodname_vscode %}, open the command palette by pressing <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux) / <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Mac).
|
|
1. Type: `mcp: add server` and then press **Enter**.
|
|
1. From the list, select **HTTP (HTTP or Server-Sent Events)**.
|
|
1. In the **Server URL** field, enter `https://api.githubcopilot.com/mcp/`, and press **Enter**.
|
|
1. Under **Enter Server ID**, press **Enter** to use the default server ID, or enter a custom server ID.
|
|
1. Under **Choose where to save the configuration**, select where you want to save the MCP server configuration.
|
|
|
|
* {% data variables.product.prodname_vscode %} will open and add the configuration to the selected file in the editor, or create a new file if it doesn't exist.
|
|
|
|
1. In the **{% data variables.product.prodname_vscode %}** popup, to authorize the MCP server with OAuth, click **Allow** and select your personal account from the list.
|
|
|
|
### Remote MCP server configuration with PAT
|
|
|
|
To configure the remote {% data variables.product.github %} MCP server with a PAT, ensure you have created a PAT with the necessary scopes for the access you want to grant to the MCP server. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
|
|
|
|
You will need to manually configure the MCP server in {% data variables.product.prodname_vscode %} to use the PAT for authorization.
|
|
|
|
1. In {% data variables.product.prodname_vscode %}, open the command palette by pressing <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux) / <kbd>Command</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Mac).
|
|
1. Type: `mcp: add server` and then press **Enter**.
|
|
1. From the list, select **HTTP (HTTP or Server-Sent Events)**.
|
|
1. In the **Server URL** field, enter `https://api.githubcopilot.com/mcp/`, and press **Enter**.
|
|
1. Under **Enter Server ID**, press **Enter** to use the default server ID, or enter a custom server ID.
|
|
1. Under **Choose where to save the configuration**, select where you want to save the MCP server configuration.
|
|
|
|
* {% data variables.product.prodname_vscode %} will open and add the configuration to the selected file in the editor, or create a new file if it doesn't exist.
|
|
|
|
1. In the **{% data variables.product.prodname_vscode %}** popup, to decline OAuth authorization, click **Cancel**.
|
|
1. You will need to manually edit the configuration file to use a PAT. In the configuration file, at the end of the `url` line, add the following:
|
|
|
|
```json copy
|
|
,
|
|
"headers": {
|
|
"Authorization": "Bearer ${input:github_token}"
|
|
}
|
|
},
|
|
},
|
|
"inputs": [
|
|
{
|
|
"id": "github_token",
|
|
"type": "promptString",
|
|
"description": "{% data variables.product.github %} {% data variables.product.pat_generic_title_case %}",
|
|
"password": true
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
1. A "Restart" button will appear in the file. Click "Restart" to restart the MCP server with the new configuration.
|
|
|
|
|
|
|
|
1. In the command palette, you will see a prompt to enter your GitHub token. Enter the PAT you created earlier, and press **Enter**.
|
|
* The MCP server will now be configured to use the PAT for authorization.
|
|
|
|
### Local MCP server setup
|
|
|
|
>[!NOTE]
|
|
> If you are a {% data variables.product.prodname_ghe_server %} user, and your enterprise has PAT restrictions enabled, you can only use API endpoints for scopes that are allowed by your enterprise's PAT policy. If all API endpoints are restricted, you will not be able to use the MCP server. If you are unsure about your enterprise's PAT policy, contact your enterprise administrator for more information.
|
|
|
|
Using the {% data variables.product.github %} MCP server locally requires you to have Docker installed and running on your machine. Additionally, you can only authenticate with a PAT, as OAuth is not supported for local MCP servers.
|
|
|
|
1. Ensure you have Docker installed and running on your machine. See [Docker installation instructions](https://docs.docker.com/get-docker/).
|
|
1. Create a PAT with (at least) the `read:packages` and `repo` scopes. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
|
|
1. Decide whether you want to configure the MCP server for a specific repository or for your personal instance of {% data variables.product.prodname_vscode %}.
|
|
|
|
* If you are using a specific repository, open the `.vscode/mcp.json` file in {% data variables.product.prodname_vscode %}, and add the following configuration:
|
|
|
|
```json copy
|
|
{
|
|
"inputs": [
|
|
{
|
|
"type": "promptString",
|
|
"id": "github_token",
|
|
"description": "{% data variables.product.github %} {% data variables.product.pat_generic_title_case %}",
|
|
"password": true
|
|
}
|
|
],
|
|
"servers": {
|
|
"github": {
|
|
"command": "docker",
|
|
"args": [
|
|
"run",
|
|
"-i",
|
|
"--rm",
|
|
"-e",
|
|
"GITHUB_PERSONAL_ACCESS_TOKEN",
|
|
"ghcr.io/github/github-mcp-server"
|
|
],
|
|
"env": {
|
|
"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
* If you are using your personal instance of {% data variables.product.prodname_vscode %}, open your `settings.json` file in {% data variables.product.prodname_vscode %}:
|
|
* Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (Windows/Linux) or <kbd>Cmd</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> (macOS).
|
|
* Type **Preferences: Open Settings (JSON)** and select it.
|
|
* Add the following configuration:
|
|
|
|
```json copy
|
|
{
|
|
"mcp": {
|
|
"inputs": [
|
|
{
|
|
"type": "promptString",
|
|
"id": "github_token",
|
|
"description": "{% data variables.product.github %} {% data variables.product.pat_generic_title_case %}",
|
|
"password": true
|
|
}
|
|
],
|
|
"servers": {
|
|
"github": {
|
|
"command": "docker",
|
|
"args": [
|
|
"run",
|
|
"-i",
|
|
"--rm",
|
|
"-e",
|
|
"GITHUB_PERSONAL_ACCESS_TOKEN",
|
|
"ghcr.io/github/github-mcp-server"
|
|
],
|
|
"env": {
|
|
"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
1. Save the file.
|
|
1. In the command palette, you will see a prompt to enter your {% data variables.product.github %} token. Enter the PAT you created earlier, and press **Enter**.
|
|
* The MCP server will now be configured to run locally with the PAT for authorization.
|
|
|
|
## Tool configuration
|
|
|
|
The {% data variables.product.github %} MCP server supports installing individual toolsets, either in read-only mode or with full read/write access, allowing you to tailor the server's capabilities to your specific needs. For one-click installation options of each toolset, see the [GitHub MCP server repository](https://github.com/github/github-mcp-server/blob/main/docs/remote-server.md).
|
|
|
|
## Using the {% data variables.product.github %} MCP server in {% data variables.product.prodname_vscode %}
|
|
|
|
The {% data variables.product.github %} MCP server enables you to perform a wide range of actions on {% data variables.product.github %}, via {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_vscode %}.
|
|
|
|
{% data reusables.copilot.open-chat-vs-code %}
|
|
{% data reusables.copilot.select-agent %}
|
|
1. To see the available actions, in the {% data variables.copilot.copilot_chat_short %} box, click the **Select tools** icon.
|
|
* In the **Tools** dropdown, under **MCP Server: {% data variables.product.github %}**, you will see a list of available actions.
|
|
1. In the {% data variables.copilot.copilot_chat_short %} box, type a command or question related to the action you want to perform, and press **Enter**.
|
|
* For example, you can ask the {% data variables.product.github %} MCP server to create a new issue, list pull requests, or retrieve repository information.
|
|
1. The {% data variables.product.github %} MCP server will process your request and provide a response in the chat interface.
|
|
* In the {% data variables.copilot.copilot_chat_short %} box, you may be asked to give additional permissions or provide more information to complete the action.
|
|
1. Follow the prompts to complete the action.
|
|
|
|
{% data reusables.copilot.mcp.troubleshooting-mcp-server %}
|
|
|
|
{% endvscode %}
|
|
|
|
{% visualstudio %}
|
|
|
|
{% data reusables.copilot.mcp.about-github-mcp-server %}
|
|
|
|
## Prerequisites
|
|
|
|
* **Access to {% data variables.product.prodname_copilot_short %}**. {% data reusables.copilot.subscription-prerequisite %}
|
|
* **{% data variables.product.prodname_vs %} version 17.14 or later**. For more information on installing {% data variables.product.prodname_vs %}, see the [{% data variables.product.prodname_vs %} downloads page](https://visualstudio.microsoft.com/downloads/).
|
|
* **Sign in to {% data variables.product.company_short %} from {% data variables.product.prodname_vs %}**.
|
|
* {% data reusables.copilot.mcp-policy-requirement %}
|
|
|
|
## Setting up the {% data variables.product.github %} MCP server in {% data variables.product.prodname_vs %}
|
|
|
|
The instructions below guide you through setting up the {% data variables.product.github %} MCP server in {% data variables.product.prodname_vs %}. Other MCP-compatible editors may have similar steps, but the exact process may vary.
|
|
|
|
The remote {% data variables.product.github %} MCP server uses one-click OAuth authentication by default, but you can also manually configure it to use a {% data variables.product.pat_generic %} (PAT) for authentication. If you use OAuth, the MCP server can only access the scopes you approve during sign-in. In organization-owned contexts, access may also be limited by admin policies that control which scopes and apps are permitted. If you use a PAT, the MCP server will have access to the scopes granted by the PAT, which is also subject to any PAT restrictions configured by the organization.
|
|
|
|
> [!NOTE]
|
|
> If you are an {% data variables.product.prodname_emu %}, then PAT is disabled by default, unless enabled by an enterprise administrator. If PAT is disabled, you won't be able to use PAT authentication. If you have OAuth access policy restrictions, you will need the OAuth App for each client (MCP host application) to be enabled (except {% data variables.product.prodname_vscode %} and {% data variables.product.prodname_vs %}).
|
|
|
|
For information on setting up the {% data variables.product.github %} MCP server locally, see the [GitHub MCP server repository](https://github.com/github/github-mcp-server#usage-in-other-mcp-hosts-1).
|
|
|
|
### Remote MCP server configuration with OAuth
|
|
|
|
You do not need to create a PAT or install any additional software to use the remote {% data variables.product.github %} MCP server with OAuth. You can set it up directly in {% data variables.product.prodname_vs %}.
|
|
|
|
1. In the {% data variables.product.prodname_vs %} menu bar, click **View**, then click **{% data variables.copilot.copilot_chat %}**.
|
|
1. At the bottom of the chat panel, select **Agent** from the mode dropdown.
|
|
1. In the {% data variables.copilot.copilot_chat_short %} window, click the tools icon, then click the plus icon in the tool picker window.
|
|
1. In the "Configure MCP server" pop-up window, fill out the fields.
|
|
1. For "Server ID", type `github`.
|
|
1. For "Type", select "HTTP/SSE" from the dropdown.
|
|
1. For "URL", type `https://api.githubcopilot.com/mcp/`.
|
|
1. Click **Save**. The configuration in the `mcp.json` file should look like this:
|
|
|
|
```json copy
|
|
{
|
|
"servers": {
|
|
"github": {
|
|
"url": "https://api.githubcopilot.com/mcp/"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
1. In the `mcp.json` file, click **Auth** from the CodeLens above the server to authenticate to the server. A pop-up will come up allowing you to authenticate with your {% data variables.product.github %} account.
|
|
|
|
### Remote MCP server configuration with PAT
|
|
|
|
To configure the remote {% data variables.product.github %} MCP server with a PAT, ensure you have created a PAT with the necessary scopes for the access you want to grant to the MCP server. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
|
|
|
|
1. In the {% data variables.product.prodname_vs %} menu bar, click **View**, then click **{% data variables.copilot.copilot_chat %}**.
|
|
1. At the bottom of the chat panel, select **Agent** from the mode dropdown.
|
|
1. In the {% data variables.copilot.copilot_chat_short %} window, click the tools icon, then click the plus icon in the tool picker window.
|
|
1. In the "Configure MCP server" pop-up window, fill out the fields.
|
|
1. For "Server ID", type `github`.
|
|
1. For "Type", select "HTTP/SSE" from the dropdown.
|
|
1. For "URL", type `https://api.githubcopilot.com/mcp/`.
|
|
1. Add a new header under "Headers", called "Authorization" and set to the value `Bearer YOUR_GITHUB_PAT`, replacing "YOUR_GITHUB_PAT" with your PAT.
|
|
1. Click **Save**. The configuration in the `mcp.json` file should look like this:
|
|
|
|
```json copy
|
|
{
|
|
"servers": {
|
|
"github": {
|
|
"url": "https://api.githubcopilot.com/mcp/",
|
|
"requestInit": {
|
|
"headers": {
|
|
"Authorization": "Bearer YOUR_GITHUB_PAT"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
For more information on configuring MCP servers in {% data variables.product.prodname_vs %}, see [Use MCP servers in {% data variables.product.prodname_vs %} (Preview)](https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers?view=vs-2022) in the {% data variables.product.prodname_vs %} documentation.
|
|
|
|
## Using the {% data variables.product.github %} MCP server in {% data variables.product.prodname_vs %}
|
|
|
|
The {% data variables.product.github %} MCP server enables you to perform a wide range of actions on {% data variables.product.github %}, via {% data variables.copilot.copilot_chat_short %} in {% data variables.product.prodname_vs %}.
|
|
|
|
1. In the {% data variables.product.prodname_vs %} menu bar, click **View**, then click **{% data variables.copilot.copilot_chat %}**.
|
|
1. At the bottom of the chat panel, select **Agent** from the mode dropdown.
|
|
1. In the {% data variables.copilot.copilot_chat_short %} window, click the tools icon.
|
|
* Under **{% data variables.product.github %}**, you will see a list of available tools.
|
|
1. In the {% data variables.copilot.copilot_chat_short %} box, type a command or question related to the action you want to perform, and press **Enter**.
|
|
* For example, you can ask the {% data variables.product.github %} MCP server to create a new issue, list pull requests, or retrieve repository information.
|
|
1. The {% data variables.product.github %} MCP server will process your request and provide a response in the chat interface.
|
|
* In the {% data variables.copilot.copilot_chat_short %} box, you may be asked to give additional permissions or provide more information to complete the action.
|
|
1. Follow the prompts to complete the action.
|
|
|
|
{% endvisualstudio %}
|
|
|
|
{% jetbrains %}
|
|
|
|
{% data reusables.copilot.mcp.about-github-mcp-server %}
|
|
|
|
## Prerequisites
|
|
|
|
* **Access to {% data variables.product.prodname_copilot_short %}**. {% data reusables.copilot.subscription-prerequisite %}
|
|
* **A compatible JetBrains IDE**. {% data variables.product.prodname_copilot %} is compatible with the following IDEs:
|
|
|
|
{% data reusables.copilot.jetbrains-compatible-ides %}
|
|
{% data reusables.copilot.jetbrains-plugin-prerequisites %}
|
|
* {% data reusables.copilot.mcp-policy-requirement %}
|
|
|
|
## Setting up the {% data variables.product.github %} MCP server in JetBrains IDEs
|
|
|
|
The instructions below guide you through setting up the {% data variables.product.github %} MCP server in JetBrains IDEs. Other MCP-compatible editors may have similar steps, but the exact process may vary.
|
|
|
|
The remote {% data variables.product.github %} MCP server uses one-click OAuth authentication by default, but you can also manually configure it to use a {% data variables.product.pat_generic %} (PAT) for authentication. If you use OAuth, the MCP server can only access the scopes you approve during sign-in. In organization-owned contexts, access may also be limited by admin policies that control which scopes and apps are permitted. If you use a PAT, the MCP server will have access to the scopes granted by the PAT, which is also subject to any PAT restrictions configured by the organization.
|
|
|
|
> [!NOTE]
|
|
> If you are an {% data variables.product.prodname_emu %}, then PAT is disabled by default, unless enabled by an enterprise administrator. If PAT is disabled, you won't be able to use PAT authentication. If you have OAuth access policy restrictions, you will need the OAuth App for each client (MCP host application) to be enabled (except {% data variables.product.prodname_vscode %} and {% data variables.product.prodname_vs %}).
|
|
|
|
For information on setting up the {% data variables.product.github %} MCP server locally, see the [GitHub MCP server repository](https://github.com/github/github-mcp-server#usage-in-other-mcp-hosts-1).
|
|
|
|
### Remote MCP server configuration with OAuth
|
|
|
|
You do not need to create a PAT or install any additional software to use the remote {% data variables.product.github %} MCP server with OAuth. You can set it up directly in JetBrains IDEs.
|
|
|
|
{% data reusables.copilot.jetbrains-mcp-setup-steps %}
|
|
1. In the `mcp.json` file, add the following configuration:
|
|
|
|
{% data reusables.copilot.github-mcp-oauth-config-other-ides %}
|
|
|
|
1. In the "{% data variables.product.prodname_copilot %}" popup that says the "MCP server definition wants to authenticate to {% data variables.product.github %}, click **Allow**.
|
|
1. If you have not yet authorized the {% data variables.product.prodname_copilot %} plugin, in the browser popup, click **Continue** next to your personal account.
|
|
|
|
### Remote MCP server configuration with PAT
|
|
|
|
To configure the remote {% data variables.product.github %} MCP server with a PAT, ensure you have created a PAT with the necessary scopes for the access you want to grant to the MCP server. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
|
|
|
|
{% data reusables.copilot.jetbrains-mcp-setup-steps %}
|
|
1. In the `mcp.json` file, add the following configuration, replacing `YOUR_GITHUB_PAT` with the PAT you created:
|
|
|
|
```json copy
|
|
{
|
|
"servers": {
|
|
"github": {
|
|
"url": "https://api.githubcopilot.com/mcp/",
|
|
"requestInit": {
|
|
"headers": {
|
|
"Authorization": "Bearer YOUR_GITHUB_PAT"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Using the {% data variables.product.github %} MCP server in JetBrains IDEs
|
|
|
|
The {% data variables.product.github %} MCP server enables you to perform a wide range of actions on {% data variables.product.github %}, via {% data variables.copilot.copilot_chat_short %} in JetBrains IDEs.
|
|
|
|
1. Open the {% data variables.copilot.copilot_chat_short %} window by clicking the **{% data variables.copilot.copilot_chat %}** icon at the right side of the JetBrains IDE window.
|
|
|
|
|
|
1. At the top of the chat panel, click the **Agent** tab.
|
|
1. To see the available actions, in the {% data variables.copilot.copilot_chat_short %} box, click the tools icon.
|
|
* Under **MCP Server: {% data variables.product.github %}**, you will see a list of available actions.
|
|
1. In the {% data variables.copilot.copilot_chat_short %} box, type a command or question related to the action you want to perform, and press **Enter**.
|
|
* For example, you can ask the {% data variables.product.github %} MCP server to create a new issue, list pull requests, or retrieve repository information.
|
|
1. The {% data variables.product.github %} MCP server will process your request and provide a response in the chat interface.
|
|
* In the {% data variables.copilot.copilot_chat_short %} box, you may be asked to give additional permissions or provide more information to complete the action.
|
|
1. Follow the prompts to complete the action.
|
|
|
|
{% data reusables.copilot.mcp.troubleshooting-mcp-server %}
|
|
|
|
{% endjetbrains %}
|
|
|
|
{% xcode %}
|
|
|
|
{% data reusables.copilot.mcp.about-github-mcp-server %}
|
|
|
|
## Prerequisites
|
|
|
|
* **Access to {% data variables.product.prodname_copilot_short %}**. {% data reusables.copilot.subscription-prerequisite %}
|
|
* **{% data variables.product.prodname_copilot %} for Xcode extension**. See [AUTOTITLE](/copilot/configuring-github-copilot/installing-the-github-copilot-extension-in-your-environment).
|
|
* {% data reusables.copilot.mcp-policy-requirement %}
|
|
|
|
## Setting up the {% data variables.product.github %} MCP server in Xcode
|
|
|
|
The instructions below guide you through setting up the {% data variables.product.github %} MCP server in Xcode. Other MCP-compatible editors may have similar steps, but the exact process may vary.
|
|
|
|
The remote {% data variables.product.github %} MCP server uses one-click OAuth authentication by default, but you can also manually configure it to use a {% data variables.product.pat_generic %} (PAT) for authentication. If you use OAuth, the MCP server can only access the scopes you approve during sign-in. In organization-owned contexts, access may also be limited by admin policies that control which scopes and apps are permitted. If you use a PAT, the MCP server will have access to the scopes granted by the PAT, which is also subject to any PAT restrictions configured by the organization.
|
|
|
|
> [!NOTE]
|
|
> If you are an {% data variables.product.prodname_emu %}, then PAT is disabled by default, unless enabled by an enterprise administrator. If PAT is disabled, you won't be able to use PAT authentication. If you have OAuth access policy restrictions, you will need the OAuth App for each client (MCP host application) to be enabled (except {% data variables.product.prodname_vscode %} and {% data variables.product.prodname_vs %}).
|
|
|
|
For information on setting up the {% data variables.product.github %} MCP server locally, see the [GitHub MCP server repository](https://github.com/github/github-mcp-server#usage-in-other-mcp-hosts-1).
|
|
|
|
### Remote MCP server configuration with OAuth
|
|
|
|
You do not need to create a PAT or install any additional software to use the remote {% data variables.product.github %} MCP server with OAuth. You can set it up directly in Xcode.
|
|
|
|
{% data reusables.copilot.xcode-mcp-setup-steps %}
|
|
1. Add the following configuration:
|
|
|
|
{% data reusables.copilot.github-mcp-oauth-config-other-ides %}
|
|
|
|
1. In the "{% data variables.product.prodname_copilot %}" popup that says the "MCP Server Definition wants to authenticate to {% data variables.product.github %}", click **Continue**.
|
|
1. If you have not yet authorized the {% data variables.product.prodname_copilot %} plugin, in the browser popup, click **Continue** next to your personal account.
|
|
|
|
### Remote MCP server configuration with PAT
|
|
|
|
To configure the remote {% data variables.product.github %} MCP server with a PAT, ensure you have created a PAT with the necessary scopes for the access you want to grant to the MCP server. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
|
|
|
|
{% data reusables.copilot.xcode-mcp-setup-steps %}
|
|
1. Add the following configuration, replacing `YOUR_GITHUB_PAT` with the PAT you created:
|
|
|
|
```json copy
|
|
{
|
|
"servers": {
|
|
"github": {
|
|
"url": "https://api.githubcopilot.com/mcp/",
|
|
"requestInit": {
|
|
"headers": {
|
|
"Authorization": "Bearer YOUR_GITHUB_PAT"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Using the {% data variables.product.github %} MCP server in Xcode
|
|
|
|
The {% data variables.product.github %} MCP server enables you to perform a wide range of actions on {% data variables.product.github %}, via {% data variables.copilot.copilot_chat_short %} in Xcode.
|
|
|
|
1. To open the chat view, click **Editor** in the menu bar, then click **{% octicon "copilot" aria-hidden="true" aria-label="copilot" %} {% data variables.product.prodname_copilot_short %}** then **Open Chat**. {% data variables.copilot.copilot_chat_short %} opens in a new window.
|
|
1. At the bottom of the chat panel, select **Agent**.
|
|
1. To see the available actions, in the {% data variables.copilot.copilot_chat_short %} box, click the tools icon.
|
|
* Under **MCP Server: {% data variables.product.github %}**, you will see a list of available actions.
|
|
1. In the {% data variables.copilot.copilot_chat_short %} box, type a command or question related to the action you want to perform, and press **Enter**.
|
|
* For example, you can ask the {% data variables.product.github %} MCP server to create a new issue, list pull requests, or retrieve repository information.
|
|
1. The {% data variables.product.github %} MCP server will process your request and provide a response in the chat interface.
|
|
* In the {% data variables.copilot.copilot_chat_short %} box, you may be asked to give additional permissions or provide more information to complete the action.
|
|
1. Follow the prompts to complete the action.
|
|
|
|
{% data reusables.copilot.mcp.troubleshooting-mcp-server %}
|
|
|
|
{% endxcode %}
|
|
|
|
{% eclipse %}
|
|
|
|
{% data reusables.copilot.mcp.about-github-mcp-server %}
|
|
|
|
## Prerequisites
|
|
|
|
{% data reusables.copilot.eclipse-prerequisites %}
|
|
* **Latest version of the {% data variables.product.prodname_copilot %} extension**. Download this from the [Eclipse Marketplace](https://aka.ms/copiloteclipse). For more information, see [AUTOTITLE](/copilot/managing-copilot/configure-personal-settings/installing-the-github-copilot-extension-in-your-environment?tool=eclipse).
|
|
* **Sign in to {% data variables.product.company_short %} from Eclipse**.
|
|
* {% data reusables.copilot.mcp-policy-requirement %}
|
|
|
|
## Setting up the {% data variables.product.github %} MCP server in Eclipse
|
|
|
|
The instructions below guide you through setting up the {% data variables.product.github %} MCP server in Eclipse. Other MCP-compatible editors may have similar steps, but the exact process may vary.
|
|
|
|
The remote {% data variables.product.github %} MCP server uses one-click OAuth authentication by default, but you can also manually configure it to use a {% data variables.product.pat_generic %} (PAT) for authentication. If you use OAuth, the MCP server can only access the scopes you approve during sign-in. In organization-owned contexts, access may also be limited by admin policies that control which scopes and apps are permitted. If you use a PAT, the MCP server will have access to the scopes granted by the PAT, which is also subject to any PAT restrictions configured by the organization.
|
|
|
|
> [!NOTE]
|
|
> If you are an {% data variables.product.prodname_emu %}, then PAT is disabled by default, unless enabled by an enterprise administrator. If PAT is disabled, you won't be able to use PAT authentication. If you have OAuth access policy restrictions, you will need the OAuth App for each client (MCP host application) to be enabled (except {% data variables.product.prodname_vscode %} and {% data variables.product.prodname_vs %}).
|
|
|
|
For information on setting up the {% data variables.product.github %} MCP server locally, see the [GitHub MCP server repository](https://github.com/github/github-mcp-server#usage-in-other-mcp-hosts-1).
|
|
|
|
### Remote MCP server configuration with OAuth
|
|
|
|
You do not need to create a PAT or install any additional software to use the remote {% data variables.product.github %} MCP server with OAuth. You can set it up directly in Eclipse.
|
|
|
|
{% data reusables.copilot.eclipse-mcp-setup-steps %}
|
|
1. Add the following configuration under "Server Configurations":
|
|
|
|
{% data reusables.copilot.github-mcp-oauth-config-other-ides %}
|
|
|
|
1. Click **Apply**.
|
|
1. In the "{% data variables.product.prodname_copilot %}" popup that says the "MCP Server Definition wants to authenticate to {% data variables.product.github %}", click **OK**.
|
|
1. If you have not yet authorized the {% data variables.product.prodname_copilot %} plugin, in the browser popup, click **Continue** next to your personal account.
|
|
|
|
### Remote MCP server configuration with PAT
|
|
|
|
To configure the remote {% data variables.product.github %} MCP server with a PAT, ensure you have created a PAT with the necessary scopes for the access you want to grant to the MCP server. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).
|
|
|
|
{% data reusables.copilot.eclipse-mcp-setup-steps %}
|
|
1. Add the following configuration under "Server Configurations", replacing `YOUR_GITHUB_PAT` with the PAT you created:
|
|
|
|
```json copy
|
|
{
|
|
"servers": {
|
|
"github": {
|
|
"url": "https://api.githubcopilot.com/mcp/",
|
|
"requestInit": {
|
|
"headers": {
|
|
"Authorization": "Bearer YOUR_GITHUB_PAT"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
## Using the {% data variables.product.github %} MCP server in Eclipse
|
|
|
|
The {% data variables.product.github %} MCP server enables you to perform a wide range of actions on {% data variables.product.github %}, via {% data variables.copilot.copilot_chat_short %} in Eclipse.
|
|
|
|
1. To open the {% data variables.copilot.copilot_chat_short %} panel, click the {% data variables.product.prodname_copilot_short %} icon ({% octicon "copilot" aria-hidden="true" aria-label="copilot" %}) in the status bar at the bottom of Eclipse, then click **Open Chat**.
|
|
1. At the bottom of the chat panel, select **Agent** from the mode dropdown.
|
|
1. To see the available actions, in the {% data variables.copilot.copilot_chat_short %} box, click the tools icon.
|
|
* Under `github`, you will see a list of available actions.
|
|
1. In the {% data variables.copilot.copilot_chat_short %} box, type a command or question related to the action you want to perform, and press **Enter**.
|
|
* For example, you can ask the {% data variables.product.github %} MCP server to create a new issue, list pull requests, or retrieve repository information.
|
|
1. The {% data variables.product.github %} MCP server will process your request and provide a response in the chat interface.
|
|
* In the {% data variables.copilot.copilot_chat_short %} box, you may be asked to give additional permissions or provide more information to complete the action.
|
|
1. Follow the prompts to complete the action.
|
|
|
|
{% data reusables.copilot.mcp.troubleshooting-mcp-server %}
|
|
|
|
{% endeclipse %}
|
|
|
|
{% webui %}
|
|
|
|
## About MCP in {% data variables.copilot.copilot_chat_dotcom_short %}
|
|
|
|
The {% data variables.product.github %} MCP server is a Model Context Protocol (MCP) server provided and maintained by {% data variables.product.github %}. MCP allows you to integrate AI capabilities with other tools and services, enhancing your development experience by providing context-aware AI assistance.
|
|
|
|
For more information on MCP, see [the official MCP documentation](https://modelcontextprotocol.io/introduction).
|
|
|
|
Within {% data variables.copilot.copilot_chat_dotcom_short %}, the {% data variables.product.github %} MCP server is automatically configured, with a limited set of skills available. This allows you to instruct {% data variables.copilot.copilot_chat_short %} to perform tasks such as creating branches or merging pull requests on your behalf. For a full list of available skills, see [AUTOTITLE](/copilot/reference/github-copilot-chat-cheat-sheet#mcp-skills).
|
|
|
|
## Using the {% data variables.product.github %} MCP server in {% data variables.copilot.copilot_chat_dotcom_short %}
|
|
|
|
The {% data variables.product.github %} MCP server is automatically configured in {% data variables.copilot.copilot_chat_dotcom_short %}. You can start using it immediately without any additional setup.
|
|
|
|
{% data reusables.copilot.immersive-mode-instructions %}
|
|
1. In the prompt box, type a request related to the skill you want {% data variables.copilot.copilot_chat_short %} to perform, and press **Enter**.
|
|
|
|
Some examples of requests you can make are:
|
|
|
|
{% prompt %}Create a new branch called [BRANCH-NAME] in the repository [OWNER/REPO-NAME].{% endprompt %}
|
|
|
|
{% prompt %}Search for users with the name [USER-NAME]{% endprompt %}
|
|
|
|
{% prompt %}Merge the pull request [PR-NUMBER] in the repository [OWNER/REPO-NAME].{% endprompt %}
|
|
|
|
1. {% data variables.copilot.copilot_chat_short %} will ask you to confirm that you want to proceed with the action. Click **Allow** to confirm.
|
|
1. {% data variables.copilot.copilot_chat_short %} will use the relevant skill from the {% data variables.product.github %} MCP server to perform the action you requested. {% data variables.copilot.copilot_chat_short %} will show you the result of the action in the chat interface.
|
|
|
|
## Limitations
|
|
|
|
The {% data variables.product.github %} MCP server in {% data variables.copilot.copilot_chat_dotcom_short %} is currently limited to a set of predefined skills. If you ask {% data variables.copilot.copilot_chat_short %} to perform an action that is not supported by the MCP server, it will still attempt to provide a helpful response, but it may not be able to perform the action as expected. For example, if you ask {% data variables.copilot.copilot_chat_short %} to create a new issue, it may provide you with a draft issue template, but you will still need to manually create the issue.
|
|
|
|
{% endwebui %}
|
|
|
|
## Further reading
|
|
|
|
* [AUTOTITLE](/copilot/tutorials/enhancing-copilot-agent-mode-with-mcp)
|
|
* [AUTOTITLE](/copilot/using-github-copilot/coding-agent/extending-copilot-coding-agent-with-mcp)
|