Skip to content

docs: Update optional headers and path params for remote server #1111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 22, 2025
+40 −5
Merged

docs: Update optional headers and path params for remote server #1111

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fd7c261
docs: Update optional headers and path params for remote server
LuluBeatson Sep 22, 2025
3a97dd4
fix typos
LuluBeatson Sep 22, 2025
c3b98a1
add note about single toolset
LuluBeatson Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 40 additions & 7 deletions docs/remote-server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,43 @@ These toolsets are only available in the remote GitHub MCP Server and are not in
| -------------------- | --------------------------------------------- | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 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) |

### Headers

You can configure toolsets and readonly mode by providing HTTP headers in your server configuration.

The headers are:
- `X-MCP-Toolsets=<toolset>,<toolset>...`
- `X-MCP-Readonly=true`
### Optional Headers

The Remote GitHub MCP server has optional headers equivalent to the Local server env vars:

- `X-MCP-Toolsets`: Comma-separated list of toolsets to enable. E.g. "repos,issue".
- Equivalent to `GITHUB_TOOLSETS` env var for Local server.
- 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.
- `X-MCP-Readonly`: Enables only "read" tools.
- Equivalent to `GITHUB_READ_ONLY` env var for Local server.
- 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.

Example:

```json
{
"type": "https",
"url": "https://api.githubcopilot.com/mcp/",
"headers": {
"X-MCP-Toolsets": "issues",
"X-MCP-Readonly": "true"
}
}
```

### URL Path Parameters

The Remote GitHub MCP server also supports the URL path parameters:

- `/x/{toolset}`
- `/x/{toolset}/readonly`
- `/readonly`

Example:

```json
{
"type": "https",
"url": "https://api.githubcopilot.com/mcp/x/issues/readonly"
}
```
Loading