Skip to main content

Using the GitHub MCP Server

Learn how to use the GitHub Model Context Protocol (MCP) server to extend Copilot Chat.

In this article

The GitHub MCP server is available to all GitHub users regardless of plan type. However, specific tools within the MCP server inherit the same access requirements as their corresponding GitHub features. If a feature requires a paid GitHub or Copilot license, the equivalent MCP tool will require the same subscription. For example, tools that interact with Copilot Coding Agent require a paid Copilot license.

About the GitHub MCP server

The GitHub MCP server is a Model Context Protocol (MCP) server provided and maintained by GitHub. MCP allows you to integrate AI capabilities with other tools and services, enhancing your development experience by providing context-aware AI assistance.

For a full introduction to the GitHub MCP server and an overview of MCP, see About Model Context Protocol (MCP).

Prerequisites

  • A GitHub account.
  • Visual Studio Code, or another MCP-compatible editor.
  • If you are a member of an organization or enterprise with a Copilot Business or Copilot Enterprise plan, the "MCP servers in Copilot" policy must be enabled in order to use MCP with Copilot.

Setting up the GitHub MCP server in Visual Studio Code

The instructions below guide you through setting up the GitHub MCP server in Visual Studio Code. Other MCP-compatible editors may have similar steps, but the exact process may vary.

You can choose to set up the GitHub MCP server either remotely or locally, depending on your needs and preferences. You can also configure your GitHub MCP server for either:

  • A specific repository. This enables you to share MCP servers with anyone who opens the project in Visual Studio Code. To do this, create a .vscode/mcp.json file in the root of your repository.
  • Your personal instance of Visual Studio Code. You will be the only person who has access to configured MCP servers. To do this, add the configuration to your settings.json file in Visual Studio Code. MCP servers configured this way will be available in all workspaces.

The remote GitHub MCP server uses one-click OAuth authentication by default, but you can also manually configure it to use a personal access token (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 Enterprise Managed User, 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 Visual Studio Code and Visual Studio since they are first-party Microsoft IDEs with native Copilot integration).

Remote MCP server configuration with OAuth

Note

The remote GitHub MCP server is not available to GitHub Enterprise Server users. If you are using GitHub Enterprise Server, you can install the GitHub MCP server locally. See Local MCP server setup.

You do not need to create a PAT or install any additional software to use the remote GitHub MCP server with OAuth. You can set it up directly in Visual Studio Code. 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.

  1. In Visual Studio Code, open the command palette by pressing Ctrl+Shift+P (Windows/Linux) / Command+Shift+P (Mac).

  2. Type: mcp: add server and then press Enter.

  3. From the list, select HTTP (HTTP or Server-Sent Events).

  4. In the Server URL field, enter https://api.githubcopilot.com/mcp/, and press Enter.

  5. Under Enter Server ID, press Enter to use the default server ID, or enter a custom server ID.

  6. Under Choose where to save the configuration, select where you want to save the MCP server configuration.

    • Visual Studio Code will open and add the configuration to the selected file in the editor, or create a new file if it doesn't exist.

  7. In the Visual Studio Code 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 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 Managing your personal access tokens.

You will need to manually configure the MCP server in Visual Studio Code to use the PAT for authorization.

  1. In Visual Studio Code, open the command palette by pressing Ctrl+Shift+P (Windows/Linux) / Command+Shift+P (Mac).

  2. Type: mcp: add server and then press Enter.

  3. From the list, select HTTP (HTTP or Server-Sent Events).

  4. In the Server URL field, enter https://api.githubcopilot.com/mcp/, and press Enter.

  5. Under Enter Server ID, press Enter to use the default server ID, or enter a custom server ID.

  6. Under Choose where to save the configuration, select where you want to save the MCP server configuration.

    • Visual Studio Code will open and add the configuration to the selected file in the editor, or create a new file if it doesn't exist.

  7. In the Visual Studio Code popup, to decline OAuth authorization, click Cancel.

  8. 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
     ,
 "headers": {
 "Authorization": "Bearer ${input:github_token}"
 }
 },
 },
 "inputs": [
 {
 "id": "github_token",
 "type": "promptString",
 "description": "GitHub Personal Access Token",
 "password": true
 }
 ]
}

  9. A "Restart" button will appear in the file. Click "Restart" to restart the MCP server with the new configuration.

    Screenshot of the MCP server restart button in the configuration file. The "Restart" button is outlined in dark orange.

  10. 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 GitHub Enterprise 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 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.

  2. Create a PAT with (at least) the read:packages and repo scopes. For more information, see Managing your personal access tokens.

  3. Decide whether you want to configure the MCP server for a specific repository or for your personal instance of Visual Studio Code.

    • If you are using a specific repository, open the .vscode/mcp.json file in Visual Studio Code, and add the following configuration:
    JSON
     {
 "inputs": [
 {
 "type": "promptString",
 "id": "github_token",
 "description": "GitHub Personal Access Token",
 "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 Visual Studio Code, open your settings.json file in Visual Studio Code:
      • Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (macOS).
      • Type Preferences: Open Settings (JSON) and select it.
      • Add the following configuration:
    JSON
    {
 "mcp": {
 "inputs": [
 {
 "type": "promptString",
 "id": "github_token",
 "description": "GitHub Personal Access Token",
 "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}"
 }
 }
 }
 }
}

  4. Save the file.

  5. 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 run locally with the PAT for authorization.

Tool configuration

The 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.

Using the GitHub MCP server in Visual Studio Code

The GitHub MCP server enables you to perform a wide range of actions on GitHub, via Copilot Chat in Visual Studio Code.

  1. Open Copilot Chat by clicking the icon in the title bar of Visual Studio Code.
  2. In the Copilot Chat box, select Agent from the popup menu.
  3. To see the available actions, in the Copilot Chat box, click the Select tools icon.
    • In the Tools dropdown, under MCP Server: GitHub, you will see a list of available actions.
  4. In the Copilot Chat box, type a command or question related to the action you want to perform, and press Enter.
    • For example, you can ask the GitHub MCP server to create a new issue, list pull requests, or retrieve repository information.
  5. The GitHub MCP server will process your request and provide a response in the chat interface.
    • In the Copilot Chat box, you may be asked to give additional permissions or provide more information to complete the action.
  6. Follow the prompts to complete the action.

Troubleshooting

If you encounter issues while using the GitHub MCP server, there are a few common troubleshooting steps you can take.

Authorization issues

If you are having trouble authorizing the MCP server, ensure that:

  • You are signed in to GitHub in your choice of IDE.

If you are authenticating with a personal access token (PAT), ensure that:

  • Your GitHub PAT is valid and has the necessary scopes for the actions you want to perform.
  • You have entered the correct PAT.

Copilot agent mode problems

If you are having trouble with the Copilot Chat agent mode, ensure that:

  • You have selected the correct agent in the Copilot Chat box.
  • You have configured the MCP server correctly in your IDE.
  • You have the necessary permissions to perform the actions you are trying to execute.

Push protection block

If you are using the GitHub MCP server and push protection blocks a secret that you believe is safe to expose, you may be able to bypass the block by specifying a reason for allowing the secret. See Working with push protection and the GitHub MCP server.

General tips

If you are experiencing other issues with the GitHub MCP server, here are some general tips to help you troubleshoot:

  • Check the output logs of the MCP server for any error messages.
  • If you are running the MCP server locally, ensure that your local environment is set up correctly for running Docker containers.
  • Try restarting the MCP server or your IDE.

About the GitHub MCP server

The GitHub MCP server is a Model Context Protocol (MCP) server provided and maintained by GitHub. MCP allows you to integrate AI capabilities with other tools and services, enhancing your development experience by providing context-aware AI assistance.

For a full introduction to the GitHub MCP server and an overview of MCP, see About Model Context Protocol (MCP).

Prerequisites

  • Access to Copilot. See What is GitHub Copilot?.
  • Visual Studio version 17.14 or later. For more information on installing Visual Studio, see the Visual Studio downloads page.
  • Sign in to GitHub from Visual Studio.
  • If you are a member of an organization or enterprise with a Copilot Business or Copilot Enterprise plan, the "MCP servers in Copilot" policy must be enabled in order to use MCP with Copilot.

Setting up the GitHub MCP server in Visual Studio

The instructions below guide you through setting up the GitHub MCP server in Visual Studio. Other MCP-compatible editors may have similar steps, but the exact process may vary.

The remote GitHub MCP server uses one-click OAuth authentication by default, but you can also manually configure it to use a personal access token (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 Enterprise Managed User, 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 Visual Studio Code and Visual Studio).

For information on setting up the GitHub MCP server locally, see the GitHub MCP server repository.

Remote MCP server configuration with OAuth

You do not need to create a PAT or install any additional software to use the remote GitHub MCP server with OAuth. You can set it up directly in Visual Studio.

  1. In the Visual Studio menu bar, click View, then click GitHub Copilot Chat.

  2. At the bottom of the chat panel, select Agent from the mode dropdown.

  3. In the Copilot Chat window, click the tools icon, then click the plus icon in the tool picker window.

  4. In the "Configure MCP server" pop-up window, fill out the fields.

    1. For "Server ID", type github.
    2. For "Type", select "HTTP/SSE" from the dropdown.
    3. For "URL", type https://api.githubcopilot.com/mcp/.

  5. Click Save. The configuration in the mcp.json file should look like this:

    JSON
     {
 "servers": {
 "github": {
 "url": "https://api.githubcopilot.com/mcp/"
 }
 }
 }

  6. 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 GitHub account.

Remote MCP server configuration with PAT

To configure the remote 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 Managing your personal access tokens.

  1. In the Visual Studio menu bar, click View, then click GitHub Copilot Chat.

  2. At the bottom of the chat panel, select Agent from the mode dropdown.

  3. In the Copilot Chat window, click the tools icon, then click the plus icon in the tool picker window.

  4. In the "Configure MCP server" pop-up window, fill out the fields.

    1. For "Server ID", type github.
    2. For "Type", select "HTTP/SSE" from the dropdown.
    3. For "URL", type https://api.githubcopilot.com/mcp/.
    4. Add a new header under "Headers", called "Authorization" and set to the value Bearer YOUR_GITHUB_PAT, replacing "YOUR_GITHUB_PAT" with your PAT.

  5. Click Save. The configuration in the mcp.json file should look like this:

    JSON
     {
 "servers": {
 "github": {
 "url": "https://api.githubcopilot.com/mcp/",
 "requestInit": {
 "headers": {
 "Authorization": "Bearer YOUR_GITHUB_PAT"
 }
 }
 }
 }
 }

For more information on configuring MCP servers in Visual Studio, see Use MCP servers in Visual Studio (Preview) in the Visual Studio documentation.

Using the GitHub MCP server in Visual Studio

The GitHub MCP server enables you to perform a wide range of actions on GitHub, via Copilot Chat in Visual Studio.

  1. In the Visual Studio menu bar, click View, then click GitHub Copilot Chat.
  2. At the bottom of the chat panel, select Agent from the mode dropdown.
  3. In the Copilot Chat window, click the tools icon.
    • Under GitHub, you will see a list of available tools.
  4. In the Copilot Chat box, type a command or question related to the action you want to perform, and press Enter.
    • For example, you can ask the GitHub MCP server to create a new issue, list pull requests, or retrieve repository information.
  5. The GitHub MCP server will process your request and provide a response in the chat interface.
    • In the Copilot Chat box, you may be asked to give additional permissions or provide more information to complete the action.
  6. Follow the prompts to complete the action.

About the GitHub MCP server

The GitHub MCP server is a Model Context Protocol (MCP) server provided and maintained by GitHub. MCP allows you to integrate AI capabilities with other tools and services, enhancing your development experience by providing context-aware AI assistance.

For a full introduction to the GitHub MCP server and an overview of MCP, see About Model Context Protocol (MCP).

Prerequisites

  • Access to Copilot. See What is GitHub Copilot?.

  • A compatible JetBrains IDE. GitHub Copilot is compatible with the following IDEs:

    • IntelliJ IDEA (Ultimate, Community, Educational)
    • Android Studio
    • AppCode
    • CLion
    • Code With Me Guest
    • DataGrip
    • DataSpell
    • GoLand
    • JetBrains Client
    • MPS
    • PhpStorm
    • PyCharm (Professional, Community, Educational)
    • Rider
    • RubyMine
    • RustRover
    • WebStorm
    • Writerside

    See the JetBrains IDEs tool finder to download.

  • Latest version of the GitHub Copilot extension. See the GitHub Copilot plugin in the JetBrains Marketplace. For installation instructions, see Installing the GitHub Copilot extension in your environment.

  • Sign in to GitHub in your JetBrains IDE. For authentication instructions, see Installing the GitHub Copilot extension in your environment.

  • If you are a member of an organization or enterprise with a Copilot Business or Copilot Enterprise plan, the "MCP servers in Copilot" policy must be enabled in order to use MCP with Copilot.

Setting up the GitHub MCP server in JetBrains IDEs

The instructions below guide you through setting up the GitHub MCP server in JetBrains IDEs. Other MCP-compatible editors may have similar steps, but the exact process may vary.

The remote GitHub MCP server uses one-click OAuth authentication by default, but you can also manually configure it to use a personal access token (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 Enterprise Managed User, 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 Visual Studio Code and Visual Studio).

For information on setting up the GitHub MCP server locally, see the GitHub MCP server repository.

Remote MCP server configuration with OAuth

You do not need to create a PAT or install any additional software to use the remote GitHub MCP server with OAuth. You can set it up directly in JetBrains IDEs.

  1. In the lower right corner, click .

  2. From the menu, select "Open Chat", make sure you are in Agent mode, then click the tools icon (called "Configure your MCP server") at the bottom of the chat window.

  3. Click Add MCP Tools.

  4. In the mcp.json file, add the following configuration:

    JSON
    {
 "servers": {
 "github": {
 "type": "http",
 "url": "https://api.githubcopilot.com/mcp/"
 }
 }
}

  5. In the "GitHub Copilot" popup that says the "MCP server definition wants to authenticate to GitHub, click Allow.

  6. If you have not yet authorized the GitHub Copilot plugin, in the browser popup, click Continue next to your personal account.

Remote MCP server configuration with PAT

To configure the remote 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 Managing your personal access tokens.

  1. In the lower right corner, click .
  2. From the menu, select "Open Chat", make sure you are in Agent mode, then click the tools icon (called "Configure your MCP server") at the bottom of the chat window.
  3. Click Add MCP Tools.
  4. In the mcp.json file, add the following configuration, replacing YOUR_GITHUB_PAT with the PAT you created:
JSON
 {
 "servers": {
 "github": {
 "url": "https://api.githubcopilot.com/mcp/",
 "requestInit": {
 "headers": {
 "Authorization": "Bearer YOUR_GITHUB_PAT"
 }
 }
 }
 }
 }

Using the GitHub MCP server in JetBrains IDEs

The GitHub MCP server enables you to perform a wide range of actions on GitHub, via Copilot Chat in JetBrains IDEs.

  1. Open the Copilot Chat window by clicking the GitHub Copilot Chat icon at the right side of the JetBrains IDE window.

    Screenshot of the GitHub Copilot Chat icon in the Activity Bar.

  2. At the top of the chat panel, click the Agent tab.

  3. To see the available actions, in the Copilot Chat box, click the tools icon.

    • Under MCP Server: GitHub, you will see a list of available actions.

  4. In the Copilot Chat box, type a command or question related to the action you want to perform, and press Enter.

    • For example, you can ask the GitHub MCP server to create a new issue, list pull requests, or retrieve repository information.

  5. The GitHub MCP server will process your request and provide a response in the chat interface.

    • In the Copilot Chat box, you may be asked to give additional permissions or provide more information to complete the action.

  6. Follow the prompts to complete the action.

Troubleshooting

If you encounter issues while using the GitHub MCP server, there are a few common troubleshooting steps you can take.

Authorization issues

If you are having trouble authorizing the MCP server, ensure that:

  • You are signed in to GitHub in your choice of IDE.

If you are authenticating with a personal access token (PAT), ensure that:

  • Your GitHub PAT is valid and has the necessary scopes for the actions you want to perform.
  • You have entered the correct PAT.

Copilot agent mode problems

If you are having trouble with the Copilot Chat agent mode, ensure that:

  • You have selected the correct agent in the Copilot Chat box.
  • You have configured the MCP server correctly in your IDE.
  • You have the necessary permissions to perform the actions you are trying to execute.

Push protection block

If you are using the GitHub MCP server and push protection blocks a secret that you believe is safe to expose, you may be able to bypass the block by specifying a reason for allowing the secret. See Working with push protection and the GitHub MCP server.

General tips

If you are experiencing other issues with the GitHub MCP server, here are some general tips to help you troubleshoot:

  • Check the output logs of the MCP server for any error messages.
  • If you are running the MCP server locally, ensure that your local environment is set up correctly for running Docker containers.
  • Try restarting the MCP server or your IDE.

About the GitHub MCP server

The GitHub MCP server is a Model Context Protocol (MCP) server provided and maintained by GitHub. MCP allows you to integrate AI capabilities with other tools and services, enhancing your development experience by providing context-aware AI assistance.

For a full introduction to the GitHub MCP server and an overview of MCP, see About Model Context Protocol (MCP).

Prerequisites

Setting up the GitHub MCP server in Xcode

The instructions below guide you through setting up the GitHub MCP server in Xcode. Other MCP-compatible editors may have similar steps, but the exact process may vary.

The remote GitHub MCP server uses one-click OAuth authentication by default, but you can also manually configure it to use a personal access token (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 Enterprise Managed User, 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 Visual Studio Code and Visual Studio).

For information on setting up the GitHub MCP server locally, see the GitHub MCP server repository.

Remote MCP server configuration with OAuth

You do not need to create a PAT or install any additional software to use the remote GitHub MCP server with OAuth. You can set it up directly in Xcode.

  1. Open the GitHub Copilot for Xcode extension and go to "Settings".

    • Alternatively, in an active Xcode workspace, you can find the settings by clicking Editor in the menu bar, selecting GitHub Copilot, then clicking Open GitHub Copilot for Xcode Settings.

  2. Select the MCP tab, then click Edit Config.

  3. Add the following configuration:

    JSON
    {
 "servers": {
 "github": {
 "type": "http",
 "url": "https://api.githubcopilot.com/mcp/"
 }
 }
}

  4. In the "GitHub Copilot" popup that says the "MCP Server Definition wants to authenticate to GitHub", click Continue.

  5. If you have not yet authorized the GitHub Copilot plugin, in the browser popup, click Continue next to your personal account.

Remote MCP server configuration with PAT

To configure the remote 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 Managing your personal access tokens.

  1. Open the GitHub Copilot for Xcode extension and go to "Settings".
    • Alternatively, in an active Xcode workspace, you can find the settings by clicking Editor in the menu bar, selecting GitHub Copilot, then clicking Open GitHub Copilot for Xcode Settings.
  2. Select the MCP tab, then click Edit Config.
  3. Add the following configuration, replacing YOUR_GITHUB_PAT with the PAT you created:
JSON
 {
 "servers": {
 "github": {
 "url": "https://api.githubcopilot.com/mcp/",
 "requestInit": {
 "headers": {
 "Authorization": "Bearer YOUR_GITHUB_PAT"
 }
 }
 }
 }
 }

Using the GitHub MCP server in Xcode

The GitHub MCP server enables you to perform a wide range of actions on GitHub, via Copilot Chat in Xcode.

  1. To open the chat view, click Editor in the menu bar, then click Copilot then Open Chat. Copilot Chat opens in a new window.
  2. At the bottom of the chat panel, select Agent.
  3. To see the available actions, in the Copilot Chat box, click the tools icon.
    • Under MCP Server: GitHub, you will see a list of available actions.
  4. In the Copilot Chat box, type a command or question related to the action you want to perform, and press Enter.
    • For example, you can ask the GitHub MCP server to create a new issue, list pull requests, or retrieve repository information.
  5. The GitHub MCP server will process your request and provide a response in the chat interface.
    • In the Copilot Chat box, you may be asked to give additional permissions or provide more information to complete the action.
  6. Follow the prompts to complete the action.

Troubleshooting

If you encounter issues while using the GitHub MCP server, there are a few common troubleshooting steps you can take.

Authorization issues

If you are having trouble authorizing the MCP server, ensure that:

  • You are signed in to GitHub in your choice of IDE.

If you are authenticating with a personal access token (PAT), ensure that:

  • Your GitHub PAT is valid and has the necessary scopes for the actions you want to perform.
  • You have entered the correct PAT.

Copilot agent mode problems

If you are having trouble with the Copilot Chat agent mode, ensure that:

  • You have selected the correct agent in the Copilot Chat box.
  • You have configured the MCP server correctly in your IDE.
  • You have the necessary permissions to perform the actions you are trying to execute.

Push protection block

If you are using the GitHub MCP server and push protection blocks a secret that you believe is safe to expose, you may be able to bypass the block by specifying a reason for allowing the secret. See Working with push protection and the GitHub MCP server.

General tips

If you are experiencing other issues with the GitHub MCP server, here are some general tips to help you troubleshoot:

  • Check the output logs of the MCP server for any error messages.
  • If you are running the MCP server locally, ensure that your local environment is set up correctly for running Docker containers.
  • Try restarting the MCP server or your IDE.

About the GitHub MCP server

The GitHub MCP server is a Model Context Protocol (MCP) server provided and maintained by GitHub. MCP allows you to integrate AI capabilities with other tools and services, enhancing your development experience by providing context-aware AI assistance.

For a full introduction to the GitHub MCP server and an overview of MCP, see About Model Context Protocol (MCP).

Prerequisites

  • Access to Copilot. See What is GitHub Copilot?.
  • Compatible version of Eclipse. To use the GitHub Copilot extension, you must have Eclipse version 2024-09 or above. See the Eclipse download page.
  • If you are a member of an organization or enterprise with a Copilot Business or Copilot Enterprise plan, the "MCP servers in Copilot" policy must be enabled in order to use MCP with Copilot.
  • Latest version of the GitHub Copilot extension. Download this from the Eclipse Marketplace. For more information, see Installing the GitHub Copilot extension in your environment.
  • Sign in to GitHub from Eclipse.
  • If you are a member of an organization or enterprise with a Copilot Business or Copilot Enterprise plan, the "MCP servers in Copilot" policy must be enabled in order to use MCP with Copilot.

Setting up the GitHub MCP server in Eclipse

The instructions below guide you through setting up the GitHub MCP server in Eclipse. Other MCP-compatible editors may have similar steps, but the exact process may vary.

The remote GitHub MCP server uses one-click OAuth authentication by default, but you can also manually configure it to use a personal access token (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 Enterprise Managed User, 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 Visual Studio Code and Visual Studio).

For information on setting up the GitHub MCP server locally, see the GitHub MCP server repository.

Remote MCP server configuration with OAuth

You do not need to create a PAT or install any additional software to use the remote GitHub MCP server with OAuth. You can set it up directly in Eclipse.

  1. Click the Copilot icon () in the status bar at the bottom of Eclipse.

  2. From the menu, select Open Chat and, in the chat window, click the "Configure Tools..." icon.

    • Alternatively, you can select Edit preferences, then in the left pane, expand GitHub Copilot and click MCP.

  3. Add the following configuration under "Server Configurations":

    JSON
    {
 "servers": {
 "github": {
 "type": "http",
 "url": "https://api.githubcopilot.com/mcp/"
 }
 }
}

  4. Click Apply.

  5. In the "GitHub Copilot" popup that says the "MCP Server Definition wants to authenticate to GitHub", click OK.

  6. If you have not yet authorized the GitHub Copilot plugin, in the browser popup, click Continue next to your personal account.

Remote MCP server configuration with PAT

To configure the remote 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 Managing your personal access tokens.

  1. Click the Copilot icon () in the status bar at the bottom of Eclipse.
  2. From the menu, select Open Chat and, in the chat window, click the "Configure Tools..." icon.
    • Alternatively, you can select Edit preferences, then in the left pane, expand GitHub Copilot and click MCP.
  3. Add the following configuration under "Server Configurations", replacing YOUR_GITHUB_PAT with the PAT you created:
JSON
 {
 "servers": {
 "github": {
 "url": "https://api.githubcopilot.com/mcp/",
 "requestInit": {
 "headers": {
 "Authorization": "Bearer YOUR_GITHUB_PAT"
 }
 }
 }
 }
 }

Using the GitHub MCP server in Eclipse

The GitHub MCP server enables you to perform a wide range of actions on GitHub, via Copilot Chat in Eclipse.

  1. To open the Copilot Chat panel, click the Copilot icon () in the status bar at the bottom of Eclipse, then click Open Chat.
  2. At the bottom of the chat panel, select Agent from the mode dropdown.
  3. To see the available actions, in the Copilot Chat box, click the tools icon.
    • Under github, you will see a list of available actions.
  4. In the Copilot Chat box, type a command or question related to the action you want to perform, and press Enter.
    • For example, you can ask the GitHub MCP server to create a new issue, list pull requests, or retrieve repository information.
  5. The GitHub MCP server will process your request and provide a response in the chat interface.
    • In the Copilot Chat box, you may be asked to give additional permissions or provide more information to complete the action.
  6. Follow the prompts to complete the action.

Troubleshooting

If you encounter issues while using the GitHub MCP server, there are a few common troubleshooting steps you can take.

Authorization issues

If you are having trouble authorizing the MCP server, ensure that:

  • You are signed in to GitHub in your choice of IDE.

If you are authenticating with a personal access token (PAT), ensure that:

  • Your GitHub PAT is valid and has the necessary scopes for the actions you want to perform.
  • You have entered the correct PAT.

Copilot agent mode problems

If you are having trouble with the Copilot Chat agent mode, ensure that:

  • You have selected the correct agent in the Copilot Chat box.
  • You have configured the MCP server correctly in your IDE.
  • You have the necessary permissions to perform the actions you are trying to execute.

Push protection block

If you are using the GitHub MCP server and push protection blocks a secret that you believe is safe to expose, you may be able to bypass the block by specifying a reason for allowing the secret. See Working with push protection and the GitHub MCP server.

General tips

If you are experiencing other issues with the GitHub MCP server, here are some general tips to help you troubleshoot:

  • Check the output logs of the MCP server for any error messages.
  • If you are running the MCP server locally, ensure that your local environment is set up correctly for running Docker containers.
  • Try restarting the MCP server or your IDE.

About MCP in Copilot Chat in GitHub

The GitHub MCP server is a Model Context Protocol (MCP) server provided and maintained by 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.

Within Copilot Chat in GitHub, the GitHub MCP server is automatically configured, with a limited set of skills available. This allows you to instruct Copilot Chat to perform tasks such as creating branches or merging pull requests on your behalf. For a full list of available skills, see GitHub Copilot Chat cheat sheet.

Using the GitHub MCP server in Copilot Chat in GitHub

The GitHub MCP server is automatically configured in Copilot Chat in GitHub. You can start using it immediately without any additional setup.

  1. At the top right of any page on GitHub, click the button next to the search bar.

    The full-page, immersive, mode of Copilot Chat is displayed.

  2. In the prompt box, type a request related to the skill you want Copilot Chat to perform, and press Enter.

    Some examples of requests you can make are:

    Create a new branch called [BRANCH-NAME] in the repository [OWNER/REPO-NAME].

    Search for users with the name [USER-NAME]

    Merge the pull request [PR-NUMBER] in the repository [OWNER/REPO-NAME].

  3. Copilot Chat will ask you to confirm that you want to proceed with the action. Click Allow to confirm.

  4. Copilot Chat will use the relevant skill from the GitHub MCP server to perform the action you requested. Copilot Chat will show you the result of the action in the chat interface.

Limitations

The GitHub MCP server in Copilot Chat in GitHub is currently limited to a set of predefined skills. If you ask Copilot Chat 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 Copilot Chat to create a new issue, it may provide you with a draft issue template, but you will still need to manually create the issue.

Further reading

AltStyle によって変換されたページ (->オリジナル) /