Skip to content

Commit 4128cb6

Browse files
committed
Update docs
1 parent 8ab711a commit 4128cb6

File tree

2 files changed

+18
-19
lines changed

2 files changed

+18
-19
lines changed

README.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -342,14 +342,21 @@ If you don't have Docker, you can use `go build` to build the binary in the
342342

343343
The `github-mcp-server` binary includes a few CLI subcommands that are helpful for debugging and exploring the server.
344344

345-
- `github-mcp-server tool-search "<query>"` searches tools by name, description, and input parameter names.
346-
- Use `--max-results` to return more matches.
347-
- Output is colorized when writing to a TTY (and typically not colorized when piped).
348-
345+
- `github-mcp-server tool-search "<query>"` searches tools by name, description, and input parameter names. Use `--max-results` to return more matches.
349346
Example:
350347

351348
```bash
352-
github-mcp-server tool-search "owner" --max-results 5
349+
github-mcp-server tool-search "issue" --max-results 5
350+
```
351+
352+
- `github-mcp-server list-scopes` lists required OAuth scopes for the currently enabled tools/toolsets.
353+
354+
List required OAuth scopes for enabled tools:
355+
356+
```bash
357+
github-mcp-server list-scopes
358+
github-mcp-server list-scopes --toolsets=repos,issues,pull_requests
359+
github-mcp-server list-scopes --output=json
353360
```
354361

355362
## Tool Configuration
@@ -868,7 +875,7 @@ The following sets of tools are available:
868875
- 'add' - add a sub-issue to a parent issue in a GitHub repository.
869876
- 'remove' - remove a sub-issue from a parent issue in a GitHub repository.
870877
- 'reprioritize' - change the order of sub-issues within a parent issue in a GitHub repository. Use either 'after_id' or 'before_id' to specify the new position.
871-
(string, required)
878+
(string, required)
872879
- `owner`: Repository owner (string, required)
873880
- `replace_parent`: When true, replaces the sub-issue's current parent issue. Use with 'add' method only. (boolean, optional)
874881
- `repo`: Repository name (string, required)
@@ -1096,8 +1103,8 @@ The following sets of tools are available:
10961103

10971104
- **pull_request_read** - Get details for a single pull request
10981105
- **Required OAuth Scopes**: `repo`
1099-
- `method`: Action to specify what pull request data needs to be retrieved from GitHub.
1100-
Possible options:
1106+
- `method`: Action to specify what pull request data needs to be retrieved from GitHub.
1107+
Possible options:
11011108
1. get - Get details of a specific pull request.
11021109
2. get_diff - Get the diff of a pull request.
11031110
3. get_status - Get status of a head commit in a pull request. This reflects status of builds and checks.

docs/installation-guides/README.md

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
This directory contains detailed installation instructions for the GitHub MCP Server across different host applications and IDEs. Choose the guide that matches your development environment.
44

55
## Installation Guides by Host Application
6-
76
- **[GitHub Copilot in other IDEs](install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
87
- **[Antigravity](install-antigravity.md)** - Installation for Google Antigravity IDE
98
- **[Claude Applications](install-claude.md)** - Installation guide for Claude Web, Claude Desktop and Claude Code CLI
@@ -29,36 +28,32 @@ This directory contains detailed installation instructions for the GitHub MCP Se
2928
| Copilot in Eclipse || ✅ Full (OAuth + PAT) | Local: Docker or Go build, GitHub PAT<br>Remote: Eclipse Plug-in for Copilot 0.10.0+ | Easy |
3029

3130
**Legend:**
32-
3331
- ✅ = Fully supported
3432
- ❌ = Not yet supported
3533

36-
**Note:** Remote MCP support requires host applications to register a GitHub App or OAuth app for OAuth flow support – even if the new OAuth spec is supported by that host app. Currently, only VS Code has full remote GitHub server support.
34+
**Note:** Remote MCP support requires host applications to register a GitHub App or OAuth app for OAuth flow support – even if the new OAuth spec is supported by that host app. Currently, only VS Code has full remote GitHub server support.
3735

3836
## Installation Methods
3937

4038
The GitHub MCP Server can be installed using several methods. **Docker is the most popular and recommended approach** for most users, but alternatives are available depending on your needs:
4139

4240
### 🐳 Docker (Most Common & Recommended)
43-
4441
- **Pros**: No local build required, consistent environment, easy updates, works across all platforms
4542
- **Cons**: Requires Docker installed and running
4643
- **Best for**: Most users, especially those already using Docker or wanting the simplest setup
4744
- **Used by**: Claude Desktop, Copilot in VS Code, Cursor, Windsurf, etc.
4845

4946
### 📦 Pre-built Binary (Lightweight Alternative)
50-
5147
- **Pros**: No Docker required, direct execution via stdio, minimal setup
5248
- **Cons**: Need to manually download and manage updates, platform-specific binaries
5349
- **Best for**: Minimal environments, users who prefer not to use Docker
5450
- **Used by**: Claude Code CLI, lightweight setups
5551

5652
### 🔨 Build from Source (Advanced Users)
57-
5853
- **Pros**: Latest features, full customization, no external dependencies
5954
- **Cons**: Requires Go development environment, more complex setup
6055
- **Prerequisites**: [Go 1.24+](https://go.dev/doc/install)
61-
- **Build command**: `go build -o github-mcp-server ./cmd/github-mcp-server`
56+
- **Build command**: `go build -o github-mcp-server cmd/github-mcp-server/main.go`
6257
- **Best for**: Developers who want the latest features or need custom modifications
6358

6459
### Important Notes on the GitHub MCP Server
@@ -70,11 +65,9 @@ The GitHub MCP Server can be installed using several methods. **Docker is the mo
7065
## General Prerequisites
7166

7267
All installations with Personal Access Tokens (PAT) require:
73-
7468
- **GitHub Personal Access Token (PAT)**: [Create one here](https://github.com/settings/personal-access-tokens/new)
7569

7670
Optional (depending on installation method):
77-
7871
- **Docker** (for Docker-based installations): [Download Docker](https://www.docker.com/)
7972
- **Go 1.24+** (for building from source): [Install Go](https://go.dev/doc/install)
8073

@@ -91,7 +84,6 @@ Regardless of which installation method you choose, follow these security guidel
9184
## Getting Help
9285

9386
If you encounter issues:
94-
9587
1. Check the troubleshooting section in your specific installation guide
9688
2. Verify your GitHub PAT has the required permissions
9789
3. Ensure Docker is running (for local installations)
@@ -101,8 +93,8 @@ If you encounter issues:
10193
## Configuration Options
10294

10395
After installation, you may want to explore:
104-
10596
- **Toolsets**: Enable/disable specific GitHub API capabilities
10697
- **Read-Only Mode**: Restrict to read-only operations
10798
- **Dynamic Tool Discovery**: Enable tools on-demand
10899
- **Lockdown Mode**: Hide public issue details created by users without push access
100+

0 commit comments

Comments
 (0)