Skip to content

Commit fa12d2f

Browse files
committed
restructure readme for better ghes ghec visibility
1 parent e5522fc commit fa12d2f

File tree

2 files changed

+27
-27
lines changed

2 files changed

+27
-27
lines changed

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,33 @@ To keep your GitHub PAT secure and reusable across different MCP hosts:
160160

161161
</details>
162162

163+
## GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)
164+
165+
The flag `--gh-host` and the environment variable `GITHUB_HOST` can be used to set
166+
the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data residency.
167+
168+
- 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.
170+
``` json
171+
"github": {
172+
"command": "docker",
173+
"args": [
174+
"run",
175+
"-i",
176+
"--rm",
177+
"-e",
178+
"GITHUB_PERSONAL_ACCESS_TOKEN",
179+
"-e",
180+
"GITHUB_HOST",
181+
"ghcr.io/github/github-mcp-server"
182+
],
183+
"env": {
184+
"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
185+
"GITHUB_HOST": "https://<your GHES or ghe.com domain name>"
186+
}
187+
}
188+
```
189+
163190
## Installation
164191

165192
### Install in GitHub Copilot on VS Code
@@ -1181,33 +1208,6 @@ docker run -i --rm \
11811208
ghcr.io/github/github-mcp-server
11821209
```
11831210

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-
12111211
## i18n / Overriding Descriptions
12121212

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

cmd/github-mcp-server/main.go

100644100755
File mode changed.

0 commit comments

Comments
 (0)