Tommy/server-config-docs (#1495) · github/github-mcp-server@9c73e88 · GitHub
Skip to content

Commit 9c73e88

Browse files
tommaso-moroCopilottonytrg
authored
Tommy/server-config-docs (#1495)
* small doc update to add x-mcp-tools header * update * add server configuration guide * update * Update docs/server-configuration.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/remote-server.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/server-configuration.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/server-configuration.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/server-configuration.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/server-configuration.md Co-authored-by: Tony Truong <tonytrg@github.com> * use relative paths * use relative path --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Tony Truong <tonytrg@github.com>
1 parent 4d6d64e commit 9c73e88

3 files changed

Lines changed: 359 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 0 deletions

‎docs/remote-server.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,18 +53,23 @@ These toolsets are only available in the remote GitHub MCP Server and are not in
5353

5454
### Optional Headers
5555

56-
The Remote GitHub MCP server has optional headers equivalent to the Local server env vars:
56+
The Remote GitHub MCP server has optional headers equivalent to the Local server env vars or flags:
5757

5858
- `X-MCP-Toolsets`: Comma-separated list of toolsets to enable. E.g. "repos,issues".
59-
- Equivalent to `GITHUB_TOOLSETS` env var for Local server.
59+
- Equivalent to `GITHUB_TOOLSETS` env var or `--toolsets` flag for Local server.
6060
- If the list is empty, default toolsets will be used. Invalid or unknown toolsets are silently ignored without error and will not prevent the server from starting. Whitespace is ignored.
61+
- `X-MCP-Tools`: Comma-separated list of tools to enable. E.g. "get_file_contents,issue_read,pull_request_read".
62+
- Equivalent to `GITHUB_TOOLS` env var or `--tools` flag for Local server.
63+
- Invalid tools will throw an error and prevent the server from starting. Whitespace is ignored.
6164
- `X-MCP-Readonly`: Enables only "read" tools.
6265
- Equivalent to `GITHUB_READ_ONLY` env var for Local server.
6366
- 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.
6467
- `X-MCP-Lockdown`: Enables lockdown mode, hiding public issue details created by users without push access.
6568
- Equivalent to `GITHUB_LOCKDOWN_MODE` env var for Local server.
6669
- 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.
6770

71+
> **Looking for examples?** See the [Server Configuration Guide](./server-configuration.md) for common recipes like minimal setups, read-only mode, and combining tools with toolsets.
72+
6873
Example:
6974

7075
```json

‎docs/server-configuration.md‎

Lines changed: 350 additions & 0 deletions

0 commit comments

Comments
 (0)