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
+93-91Lines changed: 93 additions & 91 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:
-`pullNumber`: Pull request number (number, required)
@@ -940,13 +978,6 @@ The following sets of tools are available (all are on by default):
940
978
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
941
979
-`repo`: Repository name (string, required)
942
980
943
-
-**list_starred_repositories** - List starred repositories
944
-
-`direction`: The direction to sort the results by. (string, optional)
945
-
-`page`: Page number for pagination (min 1) (number, optional)
946
-
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
947
-
-`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)
948
-
-`username`: Username to list starred repositories for. Defaults to the authenticated user. (string, optional)
949
-
950
981
-**list_tags** - List tags
951
982
-`owner`: Repository owner (string, required)
952
983
-`page`: Page number for pagination (min 1) (number, optional)
@@ -973,14 +1004,6 @@ The following sets of tools are available (all are on by default):
973
1004
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
@@ -1038,6 +1061,27 @@ The following sets of tools are available (all are on by default):
1038
1061
1039
1062
<details>
1040
1063
1064
+
<summary>Stargazers</summary>
1065
+
1066
+
-**list_starred_repositories** - List starred repositories
1067
+
-`direction`: The direction to sort the results by. (string, optional)
1068
+
-`page`: Page number for pagination (min 1) (number, optional)
1069
+
-`perPage`: Results per page for pagination (min 1, max 100) (number, optional)
1070
+
-`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)
1071
+
-`username`: Username to list starred repositories for. Defaults to the authenticated user. (string, optional)
1072
+
1073
+
-**star_repository** - Star repository
1074
+
-`owner`: Repository owner (string, required)
1075
+
-`repo`: Repository name (string, required)
1076
+
1077
+
-**unstar_repository** - Unstar repository
1078
+
-`owner`: Repository owner (string, required)
1079
+
-`repo`: Repository name (string, required)
1080
+
1081
+
</details>
1082
+
1083
+
<details>
1084
+
1041
1085
<summary>Users</summary>
1042
1086
1043
1087
-**search_users** - Search users
@@ -1076,48 +1120,6 @@ The following sets of tools are available (all are on by default):
1076
1120
-**list_copilot_spaces** - List Copilot Spaces
1077
1121
</details>
1078
1122
1079
-
####Specifying Toolsets
1080
-
1081
-
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:
1110
-
1111
-
```bash
1112
-
./github-mcp-server --toolsets all
1113
-
```
1114
-
1115
-
Or using the environment variable:
1116
-
1117
-
```bash
1118
-
GITHUB_TOOLSETS="all" ./github-mcp-server
1119
-
```
1120
-
1121
1123
##Dynamic Tool Discovery
1122
1124
1123
1125
**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)|