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
+77-59Lines changed: 77 additions & 59 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,7 +86,17 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block
86
86
> **Note:** Each MCP host application needs to configure a GitHub App or OAuth App to support remote access via OAuth. Any host application that supports remote MCP servers should support the remote GitHub server with PAT authentication. Configuration details and support levels vary by host. Make sure to refer to the host application's documentation for more info.
87
87
88
88
### Configuration
89
-
See [Remote Server Documentation](/docs/remote-server.md) on how to pass additional configuration settings to the remote GitHub MCP Server.
89
+
90
+
#### Default toolset configuration
91
+
92
+
The default configuration is:
93
+
- context
94
+
- repos
95
+
- issues
96
+
- pull_requests
97
+
- users
98
+
99
+
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.
90
100
91
101
---
92
102
@@ -271,6 +281,50 @@ The GitHub MCP Server supports enabling or disabling specific groups of function
271
281
272
282
_Toolsets are not limited to Tools. Relevant MCP Resources and Prompts are also included where applicable._
273
283
284
+
The Local GitHub MCP Server follows the same [default toolset configuration](#default-toolset-configuration) as the remote version.
285
+
286
+
#### Specifying Toolsets
287
+
288
+
To specify toolsets you want available to the LLM, you can pass an allow-list in two ways:
The special toolset `all` can be provided to enable all available toolsets regardless of any other configuration:
317
+
318
+
```bash
319
+
./github-mcp-server --toolsets all
320
+
```
321
+
322
+
Or using the environment variable:
323
+
324
+
```bash
325
+
GITHUB_TOOLSETS="all" ./github-mcp-server
326
+
```
327
+
274
328
### Available Toolsets
275
329
276
330
The following sets of tools are available (all are on by default):
@@ -293,12 +347,12 @@ The following sets of tools are available (all are on by default):
293
347
|`repos`| GitHub Repository related tools |
294
348
|`secret_protection`| Secret protection related tools, such as GitHub Secret Scanning |
295
349
|`security_advisories`| Security advisories related tools |
350
+
|`stargazers`| GitHub Stargazers related tools |
296
351
|`users`| GitHub User related tools |
297
352
<!-- END AUTOMATED TOOLSETS -->
298
353
299
354
## Tools
300
355
301
-
302
356
<!-- START AUTOMATED TOOLS -->
303
357
<details>
304
358
@@ -917,13 +971,6 @@ Possible options:
917
971
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
918
972
-`repo`: Repository name (string, required)
919
973
920
-
-**list_starred_repositories** - List starred repositories
921
-
-`direction`: The direction to sort the results by. (string, optional)
922
-
-`page`: Page number for pagination (min 1) (number, optional)
923
-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
924
-
-`sort`: How to sort the results. Can be either 'created' (when the repository was starred) or 'updated' (when the repository was last pushed to). (string, optional)
925
-
-`username`: Username to list starred repositories for. Defaults to the authenticated user. (string, optional)
926
-
927
974
-**list_tags** - List tags
928
975
-`owner`: Repository owner (string, required)
929
976
-`page`: Page number for pagination (min 1) (number, optional)
@@ -950,14 +997,6 @@ Possible options:
950
997
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
-**list_starred_repositories** - List starred repositories
1060
+
-`direction`: The direction to sort the results by. (string, optional)
1061
+
-`page`: Page number for pagination (min 1) (number, optional)
1062
+
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
1063
+
-`sort`: How to sort the results. Can be either 'created' (when the repository was starred) or 'updated' (when the repository was last pushed to). (string, optional)
1064
+
-`username`: Username to list starred repositories for. Defaults to the authenticated user. (string, optional)
1065
+
1066
+
-**star_repository** - Star repository
1067
+
-`owner`: Repository owner (string, required)
1068
+
-`repo`: Repository name (string, required)
1069
+
1070
+
-**unstar_repository** - Unstar repository
1071
+
-`owner`: Repository owner (string, required)
1072
+
-`repo`: Repository name (string, required)
1073
+
1074
+
</details>
1075
+
1076
+
<details>
1077
+
1018
1078
<summary>Users</summary>
1019
1079
1020
1080
-**search_users** - Search users
@@ -1053,48 +1113,6 @@ Possible options:
1053
1113
-**list_copilot_spaces** - List Copilot Spaces
1054
1114
</details>
1055
1115
1056
-
#### Specifying Toolsets
1057
-
1058
-
To specify toolsets you want available to the LLM, you can pass an allow-list in two ways:
The special toolset `all` can be provided to enable all available toolsets regardless of any other configuration:
1087
-
1088
-
```bash
1089
-
./github-mcp-server --toolsets all
1090
-
```
1091
-
1092
-
Or using the environment variable:
1093
-
1094
-
```bash
1095
-
GITHUB_TOOLSETS="all" ./github-mcp-server
1096
-
```
1097
-
1098
1116
## Dynamic Tool Discovery
1099
1117
1100
1118
**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.
// Add global flags that will be shared by all commands
72
-
rootCmd.PersistentFlags().StringSlice("toolsets", github.DefaultTools, "An optional comma separated list of groups of tools to allow, defaults to enabling all")
Copy file name to clipboardExpand all lines: docs/remote-server.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,6 +34,7 @@ Below is a table of available toolsets for the remote GitHub MCP Server. Each to
34
34
| Repositories | GitHub Repository related tools |https://api.githubcopilot.com/mcp/x/repos|[Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-repos&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Frepos%22%7D)|[read-only](https://api.githubcopilot.com/mcp/x/repos/readonly)|[Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-repos&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Frepos%2Freadonly%22%7D)|
35
35
| Secret Protection | Secret protection related tools, such as GitHub Secret Scanning |https://api.githubcopilot.com/mcp/x/secret_protection|[Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-secret_protection&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fsecret_protection%22%7D)|[read-only](https://api.githubcopilot.com/mcp/x/secret_protection/readonly)|[Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-secret_protection&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fsecret_protection%2Freadonly%22%7D)|
36
36
| Security Advisories | Security advisories related tools |https://api.githubcopilot.com/mcp/x/security_advisories|[Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-security_advisories&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fsecurity_advisories%22%7D)|[read-only](https://api.githubcopilot.com/mcp/x/security_advisories/readonly)|[Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-security_advisories&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fsecurity_advisories%2Freadonly%22%7D)|
37
+
| Stargazers | GitHub Stargazers related tools |https://api.githubcopilot.com/mcp/x/stargazers|[Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-stargazers&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fstargazers%22%7D)|[read-only](https://api.githubcopilot.com/mcp/x/stargazers/readonly)|[Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-stargazers&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fstargazers%2Freadonly%22%7D)|
37
38
| Users | GitHub User related tools |https://api.githubcopilot.com/mcp/x/users|[Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-users&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fusers%22%7D)|[read-only](https://api.githubcopilot.com/mcp/x/users/readonly)|[Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-users&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fusers%2Freadonly%22%7D)|
baseInstruction:=`The GitHub MCP Server provides tools to interact with GitHub platform.
32
-
33
-
Tool selection guidance:
34
-
1. Use 'list_*' tools for broad, simple retrieval and pagination of all items of a type (e.g., all issues, all PRs, all branches) with basic filtering.
35
-
2. Use 'search_*' tools for targeted queries with specific criteria, keywords, or complex filters (e.g., issues with certain text, PRs by author, code containing functions).
31
+
baseInstruction:=`The GitHub MCP Server provides tools to interact with GitHub.
36
32
37
33
Context management:
38
34
1. Use pagination whenever possible with batches of 5-10 items.
39
-
2. Use minimal_output parameter set to true if the full information is not needed to accomplish a task.`
35
+
2. Use minimal_output parameter set to true if the full information is not needed to accomplish a task.
36
+
37
+
Tool selection guidance:
38
+
1. Use 'list_*' tools for broad, simple retrieval and pagination of all items of a type (e.g., all issues, all PRs, all branches) with basic filtering.
39
+
2. Use tools containing 'search' in their name for targeted queries with specific criteria, keywords, or complex filters (e.g., issues with certain text, PRs by author, code containing functions).`
0 commit comments