Skip to content

Commit 0586d00

Browse files
docs: use JSON config example instead of shell commands
MCP servers are run via host apps with JSON config, not directly in terminal
1 parent 675940d commit 0586d00

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -196,11 +196,23 @@ For stdio mode, you can use OAuth 2.1 instead of a Personal Access Token. The se
196196
| Docker | Device flow (enter code at github.com/login/device) | Just set `GITHUB_OAUTH_CLIENT_ID` |
197197
| Docker with port | PKCE (browser auto-opens) | Set `GITHUB_OAUTH_CALLBACK_PORT` and bind port |
198198

199-
**Quick start:**
200-
```bash
201-
export GITHUB_OAUTH_CLIENT_ID=your_client_id
202-
export GITHUB_OAUTH_CLIENT_SECRET=your_client_secret
203-
./github-mcp-server stdio
199+
**Example MCP configuration (Docker with device flow):**
200+
```json
201+
{
202+
"mcpServers": {
203+
"github": {
204+
"command": "docker",
205+
"args": ["run", "-i", "--rm",
206+
"-e", "GITHUB_OAUTH_CLIENT_ID",
207+
"-e", "GITHUB_OAUTH_CLIENT_SECRET",
208+
"ghcr.io/github/github-mcp-server"],
209+
"env": {
210+
"GITHUB_OAUTH_CLIENT_ID": "your_client_id",
211+
"GITHUB_OAUTH_CLIENT_SECRET": "your_client_secret"
212+
}
213+
}
214+
}
215+
}
204216
```
205217

206218
See [docs/oauth-authentication.md](docs/oauth-authentication.md) for full setup instructions, including how to create a GitHub OAuth App.

0 commit comments

Comments
 (0)