Skip to content

Commit 0188cc0

Browse files
authored
restructure readme for better ghes ghec visibility (#1210)
* restructure readme for better ghes ghec visibility * adding readme
1 parent e5522fc commit 0188cc0

File tree

1 file changed

+48
-27
lines changed

1 file changed

+48
-27
lines changed

README.md

Lines changed: 48 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,27 @@ The default configuration is:
9898

9999
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.
100100

101+
#### Enterprise Cloud with data residency (ghe.com)
102+
103+
GitHub Enterprise Cloud can also make use of the remote server.
104+
105+
Example for `https://octocorp.ghe.com`:
106+
```
107+
{
108+
...
109+
"proxima-github": {
110+
"type": "http",
111+
"url": "https://copilot-api.octocorp.ghe.com/mcp",
112+
"headers": {
113+
"Authorization": "Bearer ${input:github_mcp_pat}"
114+
}
115+
},
116+
...
117+
}
118+
```
119+
120+
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.
121+
101122
---
102123

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

161182
</details>
162183

184+
### GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)
185+
186+
The flag `--gh-host` and the environment variable `GITHUB_HOST` can be used to set
187+
the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data residency.
188+
189+
- 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.
190+
- For GitHub Enterprise Cloud with data residency, use `https://YOURSUBDOMAIN.ghe.com` as the hostname.
191+
``` json
192+
"github": {
193+
"command": "docker",
194+
"args": [
195+
"run",
196+
"-i",
197+
"--rm",
198+
"-e",
199+
"GITHUB_PERSONAL_ACCESS_TOKEN",
200+
"-e",
201+
"GITHUB_HOST",
202+
"ghcr.io/github/github-mcp-server"
203+
],
204+
"env": {
205+
"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
206+
"GITHUB_HOST": "https://<your GHES or ghe.com domain name>"
207+
}
208+
}
209+
```
210+
163211
## Installation
164212

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

1184-
## GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)
1185-
1186-
The flag `--gh-host` and the environment variable `GITHUB_HOST` can be used to set
1187-
the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data residency.
1188-
1189-
- 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.
1190-
- For GitHub Enterprise Cloud with data residency, use `https://YOURSUBDOMAIN.ghe.com` as the hostname.
1191-
``` json
1192-
"github": {
1193-
"command": "docker",
1194-
"args": [
1195-
"run",
1196-
"-i",
1197-
"--rm",
1198-
"-e",
1199-
"GITHUB_PERSONAL_ACCESS_TOKEN",
1200-
"-e",
1201-
"GITHUB_HOST",
1202-
"ghcr.io/github/github-mcp-server"
1203-
],
1204-
"env": {
1205-
"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
1206-
"GITHUB_HOST": "https://<your GHES or ghe.com domain name>"
1207-
}
1208-
}
1209-
```
1210-
12111232
## i18n / Overriding Descriptions
12121233

12131234
The descriptions of the tools can be overridden by creating a

0 commit comments

Comments
 (0)