15 KiB
title, intro, shortTitle, versions, defaultTool, topics, redirect_from, contentType, category
| title | intro | shortTitle | versions | defaultTool | topics | redirect_from | contentType | category | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Using the GitHub MCP Server | Learn how to use the GitHub Model Context Protocol (MCP) server to interact with repositories, issues, pull requests, and other GitHub features, directly from {% data variables.copilot.copilot_chat_short %}. | Use the GitHub MCP Server |
|
vscode |
|
|
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 %}.
- The {% data variables.product.github %} MCP server, configured in your editor. See AUTOTITLE.
- {% data reusables.copilot.mcp-policy-requirement %}
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 %}
- 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.
- 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.
- 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.
- 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.
- The {% data variables.product.github %} MCP server, configured in your editor. See AUTOTITLE.
- Sign in to {% data variables.product.company_short %} from {% data variables.product.prodname_vs %}.
- {% data reusables.copilot.mcp-policy-requirement %}
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 %}.
- In the {% data variables.product.prodname_vs %} menu bar, click View, then click {% data variables.copilot.copilot_chat %}.
- At the bottom of the chat panel, select Agent from the mode dropdown.
- 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.
- 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.
- 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.
- 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 %}
-
The {% data variables.product.github %} MCP server, configured in your editor. See AUTOTITLE.
-
{% data reusables.copilot.mcp-policy-requirement %}
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.
-
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.
-
At the top of the chat panel, click the Agent tab.
-
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.
-
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.
-
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.
-
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.
- The {% data variables.product.github %} MCP server, configured in your editor. See AUTOTITLE.
- {% data reusables.copilot.mcp-policy-requirement %}
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.
- 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.
- At the bottom of the chat panel, select Agent.
- 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.
- 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.
- 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.
- 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 %}
- The {% data variables.product.github %} MCP server, configured in your editor. See AUTOTITLE.
- Latest version of the {% data variables.product.prodname_copilot %} extension. Download this from the Eclipse Marketplace. For more information, see AUTOTITLE.
- Sign in to {% data variables.product.company_short %} from Eclipse.
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.
- 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.
- At the bottom of the chat panel, select Agent from the mode dropdown.
- 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.
- Under
- 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.
- 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.
- 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.
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.
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 %}
-
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 %}
-
{% data variables.copilot.copilot_chat_short %} will ask you to confirm that you want to proceed with the action. Click Allow to confirm.
-
{% 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 %}