From fd7c261a3a809e9e569e565cd9cb2e66cef62a83 Mon Sep 17 00:00:00 2001 From: LuluBeatson Date: Mon, 22 Sep 2025 10:32:10 +0100 Subject: [PATCH 1/3] docs: Update optional headers and path params for remote server --- docs/remote-server.md | 47 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 40 insertions(+), 7 deletions(-) diff --git a/docs/remote-server.md b/docs/remote-server.md index b6f7fa61d..04808eee9 100644 --- a/docs/remote-server.md +++ b/docs/remote-server.md @@ -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=,...` -- `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" +} +``` \ No newline at end of file From 3a97dd47327bca5c905085cbd8100a821ee949f4 Mon Sep 17 00:00:00 2001 From: LuluBeatson Date: Mon, 22 Sep 2025 10:39:28 +0100 Subject: [PATCH 2/3] fix typos --- docs/remote-server.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/remote-server.md b/docs/remote-server.md index 04808eee9..fb5fc3bb9 100644 --- a/docs/remote-server.md +++ b/docs/remote-server.md @@ -49,7 +49,7 @@ These toolsets are only available in the remote GitHub MCP Server and are not in 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". +- `X-MCP-Toolsets`: Comma-separated list of toolsets to enable. E.g. "repos,issues". - 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. @@ -60,10 +60,10 @@ Example: ```json { - "type": "https", + "type": "http", "url": "https://api.githubcopilot.com/mcp/", "headers": { - "X-MCP-Toolsets": "issues", + "X-MCP-Toolsets": "repos,issues", "X-MCP-Readonly": "true" } } @@ -81,7 +81,7 @@ Example: ```json { - "type": "https", + "type": "http", "url": "https://api.githubcopilot.com/mcp/x/issues/readonly" } ``` \ No newline at end of file From c3b98a13e0667400e2ad1f5b2589178493a90d04 Mon Sep 17 00:00:00 2001 From: LuluBeatson Date: Mon, 22 Sep 2025 10:40:42 +0100 Subject: [PATCH 3/3] add note about single toolset --- docs/remote-server.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/remote-server.md b/docs/remote-server.md index fb5fc3bb9..a4fac300a 100644 --- a/docs/remote-server.md +++ b/docs/remote-server.md @@ -77,6 +77,8 @@ The Remote GitHub MCP server also supports the URL path parameters: - `/x/{toolset}/readonly` - `/readonly` +Note: `{toolset}` can only been a single toolset, not a comma-separated list. To combine multiple toolsets, use the `X-MCP-Toolsets` header instead. + Example: ```json