Skip to content

Commit 085cd2f

Browse files
Revise GitHub MCP configuration in README
Updated the JSON configuration for GitHub integration in the README. Removed the old MCP structure and replaced it with a new format that includes server and input specifications.
1 parent bc4555f commit 085cd2f

File tree

1 file changed

+21
-52
lines changed

1 file changed

+21
-52
lines changed

README.md

Lines changed: 21 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -184,22 +184,30 @@ the hostname for GitHub Enterprise Server or GitHub Enterprise Cloud with data r
184184
- 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.
185185
- For GitHub Enterprise Cloud with data residency, use `https://YOURSUBDOMAIN.ghe.com` as the hostname.
186186
``` json
187-
"github": {
188-
"command": "docker",
189-
"args": [
190-
"run",
191-
"-i",
192-
"--rm",
193-
"-e",
194-
"GITHUB_PERSONAL_ACCESS_TOKEN",
195-
"-e",
196-
"GITHUB_HOST",
197-
"ghcr.io/github/github-mcp-server"
198-
],
199-
"env": {
187+
{
188+
"inputs": [
189+
{
190+
"type": "promptString",
191+
"id": "github_token",
192+
"description": "GitHub Personal Access Token",
193+
"password": true
194+
}
195+
],
196+
"servers": {
197+
"github": {
198+
"command": "docker",
199+
"args": [
200+
"run",
201+
"-i",
202+
"--rm",
203+
"ghcr.io/github/github-mcp-server"
204+
],
205+
"env": {
200206
"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}",
201207
"GITHUB_HOST": "https://<your GHES or ghe.com domain name>"
208+
}
202209
}
210+
}
203211
}
204212
```
205213

@@ -215,43 +223,6 @@ Install in GitHub Copilot on other IDEs (JetBrains, Visual Studio, Eclipse, etc.
215223

216224
Add the following JSON block to your IDE's MCP settings.
217225

218-
```json
219-
{
220-
"mcp": {
221-
"inputs": [
222-
{
223-
"type": "promptString",
224-
"id": "github_token",
225-
"description": "GitHub Personal Access Token",
226-
"password": true
227-
}
228-
],
229-
"servers": {
230-
"github": {
231-
"command": "docker",
232-
"args": [
233-
"run",
234-
"-i",
235-
"--rm",
236-
"-e",
237-
"GITHUB_PERSONAL_ACCESS_TOKEN",
238-
"ghcr.io/github/github-mcp-server"
239-
],
240-
"env": {
241-
"GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}"
242-
}
243-
}
244-
}
245-
}
246-
}
247-
```
248-
249-
Optionally, you can add a similar example (i.e. without the mcp key) to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with other host applications that accept the same format.
250-
251-
<details>
252-
<summary><b>Example JSON block without the MCP key included</b></summary>
253-
<br>
254-
255226
```json
256227
{
257228
"inputs": [
@@ -281,8 +252,6 @@ Optionally, you can add a similar example (i.e. without the mcp key) to a file c
281252
}
282253
```
283254

284-
</details>
285-
286255
### Install in Other MCP Hosts
287256

288257
For other MCP host applications, please refer to our installation guides:

0 commit comments

Comments
 (0)