Skip to content

Commit 02ca293

Browse files
authored
docs: Update optional headers and path params for remote server (#1111)
* docs: Update optional headers and path params for remote server * fix typos * add note about single toolset
1 parent 8beacca commit 02ca293

File tree

1 file changed

+40
-5
lines changed

1 file changed

+40
-5
lines changed

docs/remote-server.md

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,45 @@ These toolsets are only available in the remote GitHub MCP Server and are not in
4545
| -------------------- | --------------------------------------------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4646
| Copilot coding agent | Perform task with GitHub Copilot coding agent | https://api.githubcopilot.com/mcp/x/copilot | [Install](https://insiders.vscode.dev/redirect/mcp/install?name=gh-copilot&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fcopilot%22%7D) | [read-only](https://api.githubcopilot.com/mcp/x/copilot/readonly) | [Install read-only](https://insiders.vscode.dev/redirect/mcp/install?name=gh-copilot&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2Fx%2Fcopilot%2Freadonly%22%7D) |
4747

48-
### Headers
48+
### Optional Headers
4949

50-
You can configure toolsets and readonly mode by providing HTTP headers in your server configuration.
50+
The Remote GitHub MCP server has optional headers equivalent to the Local server env vars:
5151

52-
The headers are:
53-
- `X-MCP-Toolsets=<toolset>,<toolset>...`
54-
- `X-MCP-Readonly=true`
52+
- `X-MCP-Toolsets`: Comma-separated list of toolsets to enable. E.g. "repos,issues".
53+
- Equivalent to `GITHUB_TOOLSETS` env var for Local server.
54+
- If the list is empty, default toolsets will be used. If a bad toolset is provided, the server will fail to start and emit a 400 bad request status. Whitespace is ignored.
55+
- `X-MCP-Readonly`: Enables only "read" tools.
56+
- Equivalent to `GITHUB_READ_ONLY` env var for Local server.
57+
- If this header is empty, "false", "f", "no", "n", "0", or "off" (ignoring whitespace and case), it will be interpreted as false. All other values are interpreted as true.
58+
59+
Example:
60+
61+
```json
62+
{
63+
"type": "http",
64+
"url": "https://api.githubcopilot.com/mcp/",
65+
"headers": {
66+
"X-MCP-Toolsets": "repos,issues",
67+
"X-MCP-Readonly": "true"
68+
}
69+
}
70+
```
71+
72+
### URL Path Parameters
73+
74+
The Remote GitHub MCP server also supports the URL path parameters:
75+
76+
- `/x/{toolset}`
77+
- `/x/{toolset}/readonly`
78+
- `/readonly`
79+
80+
Note: `{toolset}` can only been a single toolset, not a comma-separated list. To combine multiple toolsets, use the `X-MCP-Toolsets` header instead.
81+
82+
Example:
83+
84+
```json
85+
{
86+
"type": "http",
87+
"url": "https://api.githubcopilot.com/mcp/x/issues/readonly"
88+
}
89+
```

0 commit comments

Comments
 (0)