Skip to content

Commit 9573d4d

Browse files
committed
refactor the readme
1 parent ab06f39 commit 9573d4d

File tree

1 file changed

+55
-51
lines changed

1 file changed

+55
-51
lines changed

README.md

Lines changed: 55 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,17 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block
8686
> **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.
8787
8888
### 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.
90100

91101
---
92102

@@ -271,6 +281,50 @@ The GitHub MCP Server supports enabling or disabling specific groups of function
271281

272282
_Toolsets are not limited to Tools. Relevant MCP Resources and Prompts are also included where applicable._
273283

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:
289+
290+
1. **Using Command Line Argument**:
291+
292+
```bash
293+
github-mcp-server --toolsets repos,issues,pull_requests,actions,code_security
294+
```
295+
296+
2. **Using Environment Variable**:
297+
```bash
298+
GITHUB_TOOLSETS="repos,issues,pull_requests,actions,code_security" ./github-mcp-server
299+
```
300+
301+
The environment variable `GITHUB_TOOLSETS` takes precedence over the command line argument if both are provided.
302+
303+
### Using Toolsets With Docker
304+
305+
When using Docker, you can pass the toolsets as environment variables:
306+
307+
```bash
308+
docker run -i --rm \
309+
-e GITHUB_PERSONAL_ACCESS_TOKEN=<your-token> \
310+
-e GITHUB_TOOLSETS="repos,issues,pull_requests,actions,code_security,experiments" \
311+
ghcr.io/github/github-mcp-server
312+
```
313+
314+
### The "all" Toolset
315+
316+
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+
274328
### Available Toolsets
275329

276330
The following sets of tools are available (all are on by default):
@@ -299,7 +353,6 @@ The following sets of tools are available (all are on by default):
299353

300354
## Tools
301355

302-
303356
<!-- START AUTOMATED TOOLS -->
304357
<details>
305358

@@ -1083,55 +1136,6 @@ The following sets of tools are available (all are on by default):
10831136
- **list_copilot_spaces** - List Copilot Spaces
10841137
</details>
10851138

1086-
#### Specifying Toolsets
1087-
1088-
To specify toolsets you want available to the LLM, you can pass an allow-list in two ways:
1089-
1090-
1. **Using Command Line Argument**:
1091-
1092-
```bash
1093-
github-mcp-server --toolsets repos,issues,pull_requests,actions,code_security
1094-
```
1095-
1096-
2. **Using Environment Variable**:
1097-
```bash
1098-
GITHUB_TOOLSETS="repos,issues,pull_requests,actions,code_security" ./github-mcp-server
1099-
```
1100-
1101-
The environment variable `GITHUB_TOOLSETS` takes precedence over the command line argument if both are provided.
1102-
1103-
The default configuration is:
1104-
- context
1105-
- repos
1106-
- issues
1107-
- pull_requests
1108-
- users
1109-
1110-
### Using Toolsets With Docker
1111-
1112-
When using Docker, you can pass the toolsets as environment variables:
1113-
1114-
```bash
1115-
docker run -i --rm \
1116-
-e GITHUB_PERSONAL_ACCESS_TOKEN=<your-token> \
1117-
-e GITHUB_TOOLSETS="repos,issues,pull_requests,actions,code_security,experiments" \
1118-
ghcr.io/github/github-mcp-server
1119-
```
1120-
1121-
### The "all" Toolset
1122-
1123-
The special toolset `all` can be provided to enable all available toolsets regardless of any other configuration:
1124-
1125-
```bash
1126-
./github-mcp-server --toolsets all
1127-
```
1128-
1129-
Or using the environment variable:
1130-
1131-
```bash
1132-
GITHUB_TOOLSETS="all" ./github-mcp-server
1133-
```
1134-
11351139
## Dynamic Tool Discovery
11361140

11371141
**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.

0 commit comments

Comments
 (0)