Update remote-server.md - #3023
Open
0xsarawut-eth wants to merge 1 commit into
Open
Conversation
QI'll fetch the file contents from the repository at the commit you linked: docs/remote-server.md at commit 3778a41. I'll retrieve it now.I opened docs/remote-server.md at commit 3778a41 and retrieved the Remote GitHub MCP Server documentation. Below is the file and a short summary. ```markdown name=docs/remote-server.md url=https://github.com/github/github-mcp-server/blob/3778a41476e31a072430cfee7c5d31c5f72def60/docs/remote-server.md # Remote GitHub MCP Server 🚀 [](https://insiders.vscode.dev/redirect/mcp/install?name=git[...] 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 t[...] The remote server has [additional tools](#toolsets-only-available-in-the-remote-mcp-server) that are not available in the local MCP server, such as the `create_pull_request_with_copilot` tool for [...] ## 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[...] <!-- START AUTOMATED TOOLSETS --> | Name | Description | API URL | 1-Click Install (VS Code) | Read-only Link | 1-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"><im[...] | <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.[...] | <picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/code-square-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/code-square-[...] | <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.[...] | <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.pn[...] | <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.pn[...] | <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-li[...] | <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/comme[...] | <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-ligh[...] | <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-li[...] | <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-opene[...] | <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"><img [...] | <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"><im[...] | <picture><source media="(prefers-color-scheme: dark)" srcset="../pkg/octicons/icons/organization-dark.png"><source media="(prefers-color-scheme: light)" srcset="../pkg/octicons/icons/organizatio[...] | <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.pn[...] | <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-pul[...] | <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"><im[...] | <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-[...] | <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><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"><im[...] | <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"[...] <!-- 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 --> | Name | Description | API URL | 1-Click Install (VS Code) | Read-only Link | 1-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.pn[...] | <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"><im[...] <!-- 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](./server-configuration.md) 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](../README.md#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` [...] ``` Summary (quick): - Canonical remote URL: https://api.githubcopilot.com/mcp/ - You can enable/disable toolsets and tools with headers (X-MCP-Toolsets, X-MCP-Tools). - Read-only, Lockdown, and Insiders modes are supported via headers or URL path modifiers. - There are dedicated path patterns to select default, readonly, insiders, or specific toolsets. What would you like next — a concise summary of the toolsets listed, extraction of the example snippets, or a search for where the `create_pull_request_with_copilot` tool is defined?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
QI'll fetch the file contents from the repository at the commit you linked: docs/remote-server.md at commit 3778a41. I'll retrieve it now.I opened docs/remote-server.md at commit 3778a41 and retrieved the Remote GitHub MCP Server documentation. Below is the file and a short summary.
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:
Via URL path - Append
/insidersto the URL:{ "type": "http", "url": "https://api.githubcopilot.com/mcp/insiders" }Via header - Set the
X-MCP-Insidersheader totrue:{ "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 enabledNote:
{toolset}can only be a single toolset, not a comma-separated list. To combine multiple toolsets, use theX-MCP-Toolsetsheader instead. Path modifiers like/readonlyand/insiders[...]