Oct 13, 2025 · Oct 13, 2025 · Oct 13, 2025 · Oct 13, 2025 · Oct 13, 2025
diff --git a/README.md b/README.md

 See [Remote Server Documentation](docs/remote-server.md) for full details on remote server configuration, toolsets, headers, and advanced usage. This file provides comprehensive instructions and examples for connecting, customizing, and installing the remote GitHub MCP Server in VS Code and other MCP hosts.

 #### Enterprise Cloud with data residency (ghe.com)

 GitHub Enterprise Cloud can also make use of the remote server.

 Example for `https://octocorp.ghe.com`:
 ```
 {
    ...
    "proxima-github": {
      "type": "http",
      "url": "https://copilot-api.octocorp.ghe.com/mcp",
      "headers": {
        "Authorization": "Bearer ${input:github_mcp_pat}"
      }
    },
    ...
 }
 ```

 GitHub Enterprise Server does not support remote server hosting. Please refer to [GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)](#github-enterprise-server-and-enterprise-cloud-with-data-residency-ghecom) from the local server configuration.

 ---

 ## Local GitHub MCP Server

 </details>

 ### GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)

 The flag `--gh-host` and the environment variable `GITHUB_HOST` can be used to set
 the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data residency.

 - For GitHub Enterprise Server, prefix the hostname with the `https://` URI scheme, as it otherwise defaults to `http://`, which GitHub Enterprise Server does not support.
 - For GitHub Enterprise Cloud with data residency, use `https://YOURSUBDOMAIN.ghe.com` as the hostname.
 ``` json
 "github": {
    "command": "docker",
    "args": [
    "run",
    "-i",
    "--rm",
    "-e",
    "GITHUB_PERSONAL_ACCESS_TOKEN",
    "-e",
    "GITHUB_HOST",
    "ghcr.io/github/github-mcp-server"
    ],
    "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
        "GITHUB_HOST": "https://<your GHES or ghe.com domain name>"
    }
 }
 ```

 ## Installation

 ### Install in GitHub Copilot on VS Code
  ghcr.io/github/github-mcp-server
 ```

 ## GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)

 The flag `--gh-host` and the environment variable `GITHUB_HOST` can be used to set
 the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data residency.

 - For GitHub Enterprise Server, prefix the hostname with the `https://` URI scheme, as it otherwise defaults to `http://`, which GitHub Enterprise Server does not support.
 - For GitHub Enterprise Cloud with data residency, use `https://YOURSUBDOMAIN.ghe.com` as the hostname.
 ``` json
 "github": {
    "command": "docker",
    "args": [
    "run",
    "-i",
    "--rm",
    "-e",
    "GITHUB_PERSONAL_ACCESS_TOKEN",
    "-e",
    "GITHUB_HOST",
    "ghcr.io/github/github-mcp-server"
    ],
    "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
        "GITHUB_HOST": "https://<your GHES or ghe.com domain name>"
    }
 }
 ```

 ## i18n / Overriding Descriptions

 The descriptions of the tools can be overridden by creating a
Original file line number	Diff line number	Diff line change
Expand Up		@@ -98,6 +98,27 @@ The default configuration is:

		See [Remote Server Documentation](docs/remote-server.md) for full details on remote server configuration, toolsets, headers, and advanced usage. This file provides comprehensive instructions and examples for connecting, customizing, and installing the remote GitHub MCP Server in VS Code and other MCP hosts.

		#### Enterprise Cloud with data residency (ghe.com)

		GitHub Enterprise Cloud can also make use of the remote server.

		Example for `https://octocorp.ghe.com`:
		```
		{
		...
		"proxima-github": {
		"type": "http",
		"url": "https://copilot-api.octocorp.ghe.com/mcp",
		"headers": {
		"Authorization": "Bearer ${input:github_mcp_pat}"
		}
		},
		...
		}
		```

		GitHub Enterprise Server does not support remote server hosting. Please refer to [GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)](#github-enterprise-server-and-enterprise-cloud-with-data-residency-ghecom) from the local server configuration.

		---

		## Local GitHub MCP Server
Expand DownExpand Up		@@ -160,6 +181,33 @@ To keep your GitHub PAT secure and reusable across different MCP hosts:

		</details>

		### GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)
Copy link Member omgitsadsOct 13, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. Should this be moved under VSCode? The config is specifically for VSCode. Also if we're going to use`${input:github_token}` perhaps that also needs to be provided in the config, though it's somewhat redundant doing it everywhere. Copy link ContributorAuthor tonytrgOct 13, 2025 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others.Learn more. i want to clearly seperate it - so its clear these settings are client agnostic. I will do a later review of the whole readme structure, as we keep getting complaints about settings/questions which are already in the readme docs.

		The flag `--gh-host` and the environment variable `GITHUB_HOST` can be used to set
		the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data residency.

		- For GitHub Enterprise Server, prefix the hostname with the `https://` URI scheme, as it otherwise defaults to `http://`, which GitHub Enterprise Server does not support.
		- For GitHub Enterprise Cloud with data residency, use `https://YOURSUBDOMAIN.ghe.com` as the hostname.
		``` json
		"github": {
		"command": "docker",
		"args": [
		"run",
		"-i",
		"--rm",
		"-e",
		"GITHUB_PERSONAL_ACCESS_TOKEN",
		"-e",
		"GITHUB_HOST",
		"ghcr.io/github/github-mcp-server"
		],
		"env": {
		"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
		"GITHUB_HOST": "https://<your GHES or ghe.com domain name>"
		}
		}
		```

		## Installation

		### Install in GitHub Copilot on VS Code
Expand DownExpand Up		@@ -1181,33 +1229,6 @@ docker run -i --rm \
		ghcr.io/github/github-mcp-server
		```

		## GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)

		The flag `--gh-host` and the environment variable `GITHUB_HOST` can be used to set
		the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data residency.

		- For GitHub Enterprise Server, prefix the hostname with the `https://` URI scheme, as it otherwise defaults to `http://`, which GitHub Enterprise Server does not support.
		- For GitHub Enterprise Cloud with data residency, use `https://YOURSUBDOMAIN.ghe.com` as the hostname.
		``` json
		"github": {
		"command": "docker",
		"args": [
		"run",
		"-i",
		"--rm",
		"-e",
		"GITHUB_PERSONAL_ACCESS_TOKEN",
		"-e",
		"GITHUB_HOST",
		"ghcr.io/github/github-mcp-server"
		],
		"env": {
		"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
		"GITHUB_HOST": "https://<your GHES or ghe.com domain name>"
		}
		}
		```

		## i18n / Overriding Descriptions

		The descriptions of the tools can be overridden by creating a
Expand Down