Skip to content

Commit dd11e3e

Browse files
committed
update readme
1 parent 1dc9c55 commit dd11e3e

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,28 @@ To specify toolsets you want available to the LLM, you can pass an allow-list in
343343

344344
The environment variable `GITHUB_TOOLSETS` takes precedence over the command line argument if both are provided.
345345

346+
#### Specifying Individual Tools
347+
348+
You can also configure specific tools instead of entire toolsets using the `--tools` flag. When tools are specified, they take priority over toolsets configuration, read-only mode, and dynamic toolsets.
349+
350+
1. **Using Command Line Argument**:
351+
352+
```bash
353+
github-mcp-server --tools get_file_contents,issue_read,create_pull_request
354+
```
355+
356+
2. **Using Environment Variable**:
357+
```bash
358+
GITHUB_TOOLS="get_file_contents,issue_read,create_pull_request" ./github-mcp-server
359+
```
360+
361+
**Important Notes:**
362+
- When `--tools` is specified, only the listed tools are registered, bypassing toolset enablement
363+
- Read-only mode is still respected: write tools are skipped if `--read-only` is set, even if explicitly requested
364+
- Dynamic toolsets are disabled when specific tools are configured
365+
- Resources and prompts from all toolsets are still registered to maintain functionality
366+
- Tool names must match exactly (e.g., `get_file_contents`, not `getFileContents`)
367+
346368
### Using Toolsets With Docker
347369

348370
When using Docker, you can pass the toolsets as environment variables:
@@ -354,6 +376,17 @@ docker run -i --rm \
354376
ghcr.io/github/github-mcp-server
355377
```
356378

379+
### Using Tools With Docker
380+
381+
When using Docker, you can pass specific tools as environment variables:
382+
383+
```bash
384+
docker run -i --rm \
385+
-e GITHUB_PERSONAL_ACCESS_TOKEN=<your-token> \
386+
-e GITHUB_TOOLS="get_file_contents,issue_read,create_pull_request" \
387+
ghcr.io/github/github-mcp-server
388+
```
389+
357390
### Special toolsets
358391

359392
#### "all" toolset

0 commit comments

Comments
 (0)