Back to Github Mcp Server

Remote GitHub MCP Server 🚀

docs/remote-server.md

1.0.325.1 KB
Original Source

Remote GitHub MCP Server 🚀

Easily connect to the GitHub MCP Server using the hosted version – no local setup or runtime required.

URL: https://api.githubcopilot.com/mcp/

About

The remote GitHub MCP server is built using this repository as a library, and binding it into GitHub server infrastructure with an internal repository. You can open issues and propose changes in this repository, and we regularly update the remote server to include the latest version of this code.

The remote server has additional tools that are not available in the local MCP server, such as the create_pull_request_with_copilot tool for invoking Copilot coding agent.

Remote MCP Toolsets

Below is a table of available toolsets for the remote GitHub MCP Server. Each toolset is provided as a distinct URL so you can mix and match to create the perfect combination of tools for your use-case. Add /readonly to the end of any URL to restrict the tools in the toolset to only those that enable read access. We also provide the option to use headers instead.

<!-- START AUTOMATED TOOLSETS -->
NameDescriptionAPI URL1-Click Install (VS Code)Read-only Link1-Click Read-only Install (VS Code)
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/apps-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/apps-light.png"></picture>
allAll available GitHub MCP toolshttps://api.githubcopilot.com/mcp/Installread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/workflow-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/workflow-light.png"></picture>
actionsGitHub Actions workflows and CI/CD operationshttps://api.githubcopilot.com/mcp/x/actionsInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/codescan-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/codescan-light.png"></picture>
code_securityCode security related tools, such as GitHub Code Scanninghttps://api.githubcopilot.com/mcp/x/code_securityInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/copilot-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/copilot-light.png"></picture>
copilotCopilot related toolshttps://api.githubcopilot.com/mcp/x/copilotInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/dependabot-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/dependabot-light.png"></picture>
dependabotDependabot toolshttps://api.githubcopilot.com/mcp/x/dependabotInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/comment-discussion-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/comment-discussion-light.png"></picture>
discussionsGitHub Discussions related toolshttps://api.githubcopilot.com/mcp/x/discussionsInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/logo-gist-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/logo-gist-light.png"></picture>
gistsGitHub Gist related toolshttps://api.githubcopilot.com/mcp/x/gistsInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/git-branch-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/git-branch-light.png"></picture>
gitGitHub Git API related tools for low-level Git operationshttps://api.githubcopilot.com/mcp/x/gitInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/issue-opened-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/issue-opened-light.png"></picture>
issuesGitHub Issues related toolshttps://api.githubcopilot.com/mcp/x/issuesInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/tag-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/tag-light.png"></picture>
labelsGitHub Labels related toolshttps://api.githubcopilot.com/mcp/x/labelsInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/bell-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/bell-light.png"></picture>
notificationsGitHub Notifications related toolshttps://api.githubcopilot.com/mcp/x/notificationsInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/organization-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/organization-light.png"></picture>
orgsGitHub Organization related toolshttps://api.githubcopilot.com/mcp/x/orgsInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/project-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/project-light.png"></picture>
projectsGitHub Projects related toolshttps://api.githubcopilot.com/mcp/x/projectsInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/git-pull-request-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/git-pull-request-light.png"></picture>
pull_requestsGitHub Pull Request related toolshttps://api.githubcopilot.com/mcp/x/pull_requestsInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/repo-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/repo-light.png"></picture>
reposGitHub Repository related toolshttps://api.githubcopilot.com/mcp/x/reposInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/shield-lock-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/shield-lock-light.png"></picture>
secret_protectionSecret protection related tools, such as GitHub Secret Scanninghttps://api.githubcopilot.com/mcp/x/secret_protectionInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/shield-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/shield-light.png"></picture>
security_advisoriesSecurity advisories related toolshttps://api.githubcopilot.com/mcp/x/security_advisoriesInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/star-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/star-light.png"></picture>
stargazersGitHub Stargazers related toolshttps://api.githubcopilot.com/mcp/x/stargazersInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/people-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/people-light.png"></picture>
usersGitHub User related toolshttps://api.githubcopilot.com/mcp/x/usersInstallread-onlyInstall read-only
<!-- END AUTOMATED TOOLSETS -->

Additional Remote Server Toolsets

These toolsets are only available in the remote GitHub MCP Server and are not included in the local MCP server.

<!-- START AUTOMATED REMOTE TOOLSETS -->
NameDescriptionAPI URL1-Click Install (VS Code)Read-only Link1-Click Read-only Install (VS Code)
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/copilot-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/copilot-light.png"></picture>
copilot_spacesCopilot Spaces toolshttps://api.githubcopilot.com/mcp/x/copilot_spacesInstallread-onlyInstall read-only
<picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/book-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/book-light.png"></picture>
github_support_docs_searchRetrieve documentation to answer GitHub product and support questions. Topics include: GitHub Actions Workflows, Authentication, ...https://api.githubcopilot.com/mcp/x/github_support_docs_searchInstallread-onlyInstall read-only
<!-- END AUTOMATED REMOTE TOOLSETS -->

Optional Headers

The Remote GitHub MCP server has optional headers equivalent to the Local server env vars or flags:

  • X-MCP-Toolsets: Comma-separated list of toolsets to enable. E.g. "repos,issues".
    • Equivalent to GITHUB_TOOLSETS env var or --toolsets flag for Local server.
    • If the list is empty, default toolsets will be used. Invalid or unknown toolsets are silently ignored without error and will not prevent the server from starting. Whitespace is ignored.
  • X-MCP-Tools: Comma-separated list of tools to enable. E.g. "get_file_contents,issue_read,pull_request_read".
    • Equivalent to GITHUB_TOOLS env var or --tools flag for Local server.
    • Invalid tools will throw an error and prevent the server from starting. Whitespace is ignored.
  • X-MCP-Readonly: Enables only "read" tools.
    • Equivalent to GITHUB_READ_ONLY env var for Local server.
    • If this header is empty, "false", "f", "no", "n", "0", or "off" (ignoring whitespace and case), it will be interpreted as false. All other values are interpreted as true.
  • X-MCP-Lockdown: Enables lockdown mode, hiding public issue details created by users without push access.
    • Equivalent to GITHUB_LOCKDOWN_MODE env var for Local server.
    • If this header is empty, "false", "f", "no", "n", "0", or "off" (ignoring whitespace and case), it will be interpreted as false. All other values are interpreted as true.
  • X-MCP-Insiders: Enables insiders mode for early access to new features.
    • Equivalent to GITHUB_INSIDERS env var or --insiders flag for Local server.
    • If this header is empty, "false", "f", "no", "n", "0", or "off" (ignoring whitespace and case), it will be interpreted as false. All other values are interpreted as true.

Looking for examples? See the Server Configuration Guide for common recipes like minimal setups, read-only mode, and combining tools with toolsets.

Example:

json
{
    "type": "http",
    "url": "https://api.githubcopilot.com/mcp/",
    "headers": {
        "X-MCP-Toolsets": "repos,issues",
        "X-MCP-Readonly": "true",
        "X-MCP-Lockdown": "false"
    }
}

Insiders Mode

The remote GitHub MCP Server offers an insiders version with early access to new features and experimental tools. You can enable insiders mode in two ways:

  1. Via URL path - Append /insiders to the URL:

    json
    {
        "type": "http",
        "url": "https://api.githubcopilot.com/mcp/insiders"
    }
    
  2. Via header - Set the X-MCP-Insiders header to true:

    json
    {
        "type": "http",
        "url": "https://api.githubcopilot.com/mcp/",
        "headers": {
            "X-MCP-Insiders": "true"
        }
    }
    

Both methods can be combined with other path modifiers (like /readonly) and headers.

URL Path Parameters

The Remote GitHub MCP server supports the following URL path patterns:

  • / - Default toolset (see "default" toolset)
  • /readonly - Default toolset in read-only mode
  • /insiders - Default toolset with insiders mode enabled
  • /readonly/insiders - Default toolset in read-only mode with insiders mode enabled
  • /x/all - All available toolsets
  • /x/all/readonly - All available toolsets in read-only mode
  • /x/all/insiders - All available toolsets with insiders mode enabled
  • /x/all/readonly/insiders - All available toolsets in read-only mode with insiders mode enabled
  • /x/{toolset} - Single specific toolset
  • /x/{toolset}/readonly - Single specific toolset in read-only mode
  • /x/{toolset}/insiders - Single specific toolset with insiders mode enabled
  • /x/{toolset}/readonly/insiders - Single specific toolset in read-only mode with insiders mode enabled

Note: {toolset} can only be a single toolset, not a comma-separated list. To combine multiple toolsets, use the X-MCP-Toolsets header instead. Path modifiers like /readonly and /insiders can be combined with the X-MCP-Insiders or X-MCP-Readonly headers.

Example:

json
{
    "type": "http",
    "url": "https://api.githubcopilot.com/mcp/x/issues/readonly"
}