Skip to content

Commit c2e4102

Browse files
committed
adding readme
1 parent a81cb61 commit c2e4102

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

Lines changed: 23 additions & 2 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,13 +181,13 @@ To keep your GitHub PAT secure and reusable across different MCP hosts:
160181

161182
</details>
162183

163-
## GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)
184+
### GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)
164185

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

168189
- 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.
169-
- For GitHub Enterprise Cloud with data residency, use `https://copilot-api.YOURSUBDOMAIN.ghe.com` as the hostname.
190+
- For GitHub Enterprise Cloud with data residency, use `https://YOURSUBDOMAIN.ghe.com` as the hostname.
170191
``` json
171192
"github": {
172193
"command": "docker",

0 commit comments

Comments
 (0)