You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+41-12Lines changed: 41 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,17 +87,12 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block
87
87
88
88
### Configuration
89
89
90
-
#### Default toolset configuration
91
-
92
-
The default configuration is:
93
-
- context
94
-
- repos
95
-
- issues
96
-
- pull_requests
97
-
- users
90
+
#### Toolset configuration
98
91
99
92
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.
100
93
94
+
When no toolsets are specified, [default toolsets](#default-toolset) are used.
95
+
101
96
#### Enterprise Cloud with data residency (ghe.com)
102
97
103
98
GitHub Enterprise Cloud can also make use of the remote server.
@@ -329,7 +324,7 @@ The GitHub MCP Server supports enabling or disabling specific groups of function
329
324
330
325
_Toolsets are not limited to Tools. Relevant MCP Resources and Prompts are also included where applicable._
331
326
332
-
The Local GitHub MCP Server follows the same [default toolset configuration](#default-toolset-configuration) as the remote version.
327
+
When no toolsets are specified, [default toolsets](#default-toolset) are used.
333
328
334
329
#### Specifying Toolsets
335
330
@@ -359,7 +354,9 @@ docker run -i --rm \
359
354
ghcr.io/github/github-mcp-server
360
355
```
361
356
362
-
### The "all" Toolset
357
+
### Special toolsets
358
+
359
+
#### "all" toolset
363
360
364
361
The special toolset `all` can be provided to enable all available toolsets regardless of any other configuration:
365
362
@@ -373,9 +370,25 @@ Or using the environment variable:
373
370
GITHUB_TOOLSETS="all" ./github-mcp-server
374
371
```
375
372
373
+
#### "default" toolset
374
+
The default toolset `default` is the configuration that gets passed to the server if no toolsets are specified.
375
+
376
+
The default configuration is:
377
+
- context
378
+
- repos
379
+
- issues
380
+
- pull_requests
381
+
- users
382
+
383
+
To keep the default configuration and add additional toolsets:
|`copilot`| Copilot related tools (e.g. Copilot Coding Agent) |
422
+
|`copilot_spaces`| Copilot Spaces related tools |
423
+
|`github_support_docs_search`| Search docs to answer GitHub product and support questions |
424
+
404
425
## Tools
405
426
406
427
<!-- START AUTOMATED TOOLS -->
@@ -1227,7 +1248,7 @@ Possible options:
1227
1248
1228
1249
<details>
1229
1250
1230
-
<summary>Copilot coding agent</summary>
1251
+
<summary>Copilot</summary>
1231
1252
1232
1253
-**create_pull_request_with_copilot** - Perform task with GitHub Copilot coding agent
1233
1254
-`owner`: Repository owner. You can guess the owner, but confirm it with the user before proceeding. (string, required)
@@ -1249,6 +1270,14 @@ Possible options:
1249
1270
-**list_copilot_spaces** - List Copilot Spaces
1250
1271
</details>
1251
1272
1273
+
<details>
1274
+
1275
+
<summary>GitHub Support Docs Search</summary>
1276
+
1277
+
-**github_support_docs_search** - Retrieve documentation relevant to answer GitHub product and support questions. Support topics include: GitHub Actions Workflows, Authentication, GitHub Support Inquiries, Pull Request Practices, Repository Maintenance, GitHub Pages, GitHub Packages, GitHub Discussions, Copilot Spaces
1278
+
-`query`: Input from the user about the question they need answered. This is the latest raw unedited user message. You should ALWAYS leave the user message as it is, you should never modify it. (string, required)
1279
+
</details>
1280
+
1252
1281
## Dynamic Tool Discovery
1253
1282
1254
1283
**Note**: This feature is currently in beta and may not be available in all environments. Please test it out and let us know if you encounter any issues.
> You will still need to have a personal access token with the appropriate scopes called `GITHUB_MCP_PAT` in your environment.
41
+
42
+
### Method 2: Remote Server
43
+
44
+
You can also connect to the hosted MCP server directly. After securely storing your PAT, configure Gemini CLI with:
36
45
37
46
```json
38
47
// ~/.gemini/settings.json
39
48
{
40
49
"mcpServers": {
41
50
"github": {
42
51
"httpUrl": "https://api.githubcopilot.com/mcp/",
43
-
"trust": true,
44
52
"headers": {
45
-
"Authorization": "Bearer $GITHUB_PAT"
53
+
"Authorization": "Bearer $GITHUB_MCP_PAT"
46
54
}
47
55
}
48
56
}
49
57
}
50
58
```
51
59
52
-
### Method 2: Local Docker
60
+
### Method 3: Local Docker
53
61
54
62
With docker running, you can run the GitHub MCP server in a container:
55
63
@@ -68,14 +76,14 @@ With docker running, you can run the GitHub MCP server in a container:
68
76
"ghcr.io/github/github-mcp-server"
69
77
],
70
78
"env": {
71
-
"GITHUB_PERSONAL_ACCESS_TOKEN": "$GITHUB_PAT"
79
+
"GITHUB_PERSONAL_ACCESS_TOKEN": "$GITHUB_MCP_PAT"
72
80
}
73
81
}
74
82
}
75
83
}
76
84
```
77
85
78
-
### Method 3: Binary
86
+
### Method 4: Binary
79
87
80
88
You can download the latest binary release from the [GitHub releases page](https://github.com/github/github-mcp-server/releases) or build it from source by running `go build -o github-mcp-server ./cmd/github-mcp-server`.
81
89
@@ -89,7 +97,7 @@ Then, replacing `/path/to/binary` with the actual path to your binary, configure
89
97
"command": "/path/to/binary",
90
98
"args": ["stdio"],
91
99
"env": {
92
-
"GITHUB_PERSONAL_ACCESS_TOKEN": "$GITHUB_PAT"
100
+
"GITHUB_PERSONAL_ACCESS_TOKEN": "$GITHUB_MCP_PAT"
93
101
}
94
102
}
95
103
}
@@ -122,6 +130,10 @@ To verify that the GitHub MCP server has been configured, start Gemini CLI in yo
122
130
List my GitHub repositories
123
131
```
124
132
133
+
## Additional Configuration
134
+
135
+
You can find more MCP configuration options for Gemini CLI here: [MCP Configuration Structure](https://google-gemini.github.io/gemini-cli/docs/tools/mcp-server.html#configuration-structure). For example, bypassing tool confirmations or excluding specific tools.
// See https://docs.github.com/en/[email protected]/admin/configuring-settings/hardening-security-for-your-enterprise/enabling-subdomain-isolation#about-subdomain-isolation
0 commit comments