From 65f24e271a0a99b3ff5e1705fbc73925780436b4 Mon Sep 17 00:00:00 2001 From: tommaso-moro Date: Thu, 27 Nov 2025 14:27:31 +0000 Subject: [PATCH 01/13] small doc update to add x-mcp-tools header --- docs/remote-server.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/remote-server.md b/docs/remote-server.md index ec6d2302d..803ee2003 100644 --- a/docs/remote-server.md +++ b/docs/remote-server.md @@ -56,8 +56,11 @@ 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,issues". - - Equivalent to `GITHUB_TOOLSETS` env var for Local server. + - Equivalent to `GITHUB_TOOLSETS` env var or `--toolsets` flag for Local server. - 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. +- `X-MCP-Tools`: Comma-separated list of tools to enable. E.g. "get_file_contents,issue_read,pull_request_read". + - Equivalent to `GITHUB_TOOLS` env var or `--tools` flag for Local server. + - Invalid tools will throw an error and prevent the server from starting. 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. From 303b2ad21e2676c212430893e49cf60b717f77c4 Mon Sep 17 00:00:00 2001 From: tommaso-moro Date: Thu, 27 Nov 2025 14:39:43 +0000 Subject: [PATCH 02/13] update --- docs/remote-server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/remote-server.md b/docs/remote-server.md index 803ee2003..a9933dee5 100644 --- a/docs/remote-server.md +++ b/docs/remote-server.md @@ -53,7 +53,7 @@ These toolsets are only available in the remote GitHub MCP Server and are not in ### Optional Headers -The Remote GitHub MCP server has optional headers equivalent to the Local server env vars: +The Remote GitHub MCP server has optional headers equivalent to the Local server env vars or flags: - `X-MCP-Toolsets`: Comma-separated list of toolsets to enable. E.g. "repos,issues". - Equivalent to `GITHUB_TOOLSETS` env var or `--toolsets` flag for Local server. From 7204a63f20d34d4777a1c531bf50fc29d93e893c Mon Sep 17 00:00:00 2001 From: tommaso-moro Date: Thu, 27 Nov 2025 16:35:55 +0000 Subject: [PATCH 03/13] add server configuration guide --- README.md | 2 + docs/remote-server.md | 2 + docs/server-configuration.md | 353 +++++++++++++++++++++++++++++++++++ 3 files changed, 357 insertions(+) create mode 100644 docs/server-configuration.md diff --git a/README.md b/README.md index d6925d8ab..84af210e7 100644 --- a/README.md +++ b/README.md @@ -328,6 +328,8 @@ _Toolsets are not limited to Tools. Relevant MCP Resources and Prompts are also When no toolsets are specified, [default toolsets](#default-toolset) are used. +> **Looking for examples?** See the [Server Configuration Guide](https://github.com/github/github-mcp-server/tree/main/docs/server-configuration.md) for common recipes like minimal setups, read-only mode, and combining tools with toolsets. + #### Specifying Toolsets To specify toolsets you want available to the LLM, you can pass an allow-list in two ways: diff --git a/docs/remote-server.md b/docs/remote-server.md index a9933dee5..e1ea68d67 100644 --- a/docs/remote-server.md +++ b/docs/remote-server.md @@ -68,6 +68,8 @@ The Remote GitHub MCP server has optional headers equivalent to the Local server - Equivalent to `GITHUB_LOCKDOWN_MODE` 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. +> **Looking for examples?** See the [Server Configuration Guide](https://github.com/github/github-mcp-server/tree/main/docs/server-configuration.md) for common recipes like minimal setups, read-only mode, and combining tools with toolsets. + Example: ```json diff --git a/docs/server-configuration.md b/docs/server-configuration.md new file mode 100644 index 000000000..ed398974d --- /dev/null +++ b/docs/server-configuration.md @@ -0,0 +1,353 @@ +# Server Configuration Guide + +This guide helps you choose the right configuration for your use case and shows you how to apply it. For the complete reference of available toolsets and tools, see the [README](https://github.com/github/github-mcp-server?tab=readme-ov-file#tool-configuration). + +## Quick Reference +We currently support the following ways in which the GitHub MCP Server can be configured: + +| Configuration | Remote Server | Local Server | +|---------------|---------------|--------------| +| Toolsets | `X-MCP-Toolsets` header or `/x/{toolset}` URL | `--toolsets` flag or `GITHUB_TOOLSETS` env var | +| Individual Tools | `X-MCP-Tools` header | `--tools` flag or `GITHUB_TOOLS` env var | +| Read-Only Mode | `X-MCP-Readonly` header or `/readonly` URL | `--read-only` flag or `GITHUB_READ_ONLY` env var | +| Dynamic Mode | Not available | `--dynamic-toolsets` flag or `GITHUB_DYNAMIC_TOOLSETS` env var | +| Lockdown Mode | `X-MCP-Lockdown` header | `--lockdown-mode` flag or `GITHUB_LOCKDOWN_MODE` env var | + +> **Default behavior:** If you don't specify any configuration, the server uses the **default toolsets**: `context`, `issues`, `pull_requests`, `repos`, `users`. + +--- + +## How Configuration Works + +All configuration options are **composable**: you can combine toolsets, individual tools, dynamic discovery, read-only mode and lockdown mode in any way that suits your workflow. + +For example: +- **Tools + Toolsets**: The server enables the union of both +- **Dynamic mode + Tools**: Start minimal with the tools you know you need, and discover more toolsets on demand +- **Read-Only Mode**: Acts as a strict security filter that takes precedence over any other configuration, by disabling write tools are excluded even if explicitly requested + +--- + +## Configuration Examples + +The examples below use VS Code configuration format to illustrate the concepts. If you're using a different MCP host (Cursor, Claude Desktop, JetBrains, etc.), your configuration might need to look slightly different. See [installation guides](https://github.com/github/github-mcp-server/tree/main/docs/installation-guides) for host-specific setup. + +### Enabling Specific Tools + +**Best for:** users who know exactly what they need and want to optimize context usage by loading only the tools they will use. + +**Example:** + + + + + + + +
Remote ServerLocal Server
+ +```json +{ + "type": "http", + "url": "https://api.githubcopilot.com/mcp/", + "headers": { + "X-MCP-Tools": "get_file_contents,get_me,pull_request_read" + } +} +``` + + + +```json +{ + "type": "stdio", + "command": "go", + "args": [ + "run", + "./cmd/github-mcp-server", + "stdio", + "--tools=get_file_contents,get_me,pull_request_read" + ], + "env": { + "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}" + } +} +``` + +
+ +--- + +### Enabling Specific Toolsets + +**Best for:** Users who want to enable multiple related toolsets. + + + + + + + +
Remote ServerLocal Server
+ +```json +{ + "type": "http", + "url": "https://api.githubcopilot.com/mcp/", + "headers": { + "X-MCP-Toolsets": "issues,pull_requests" + } +} +``` + + + +```json +{ + "type": "stdio", + "command": "go", + "args": [ + "run", + "./cmd/github-mcp-server", + "stdio", + "--toolsets=issues,pull_requests" + ], + "env": { + "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}" + } +} +``` + +
+ +--- + +### Enabling Toolsets + Tools + +**Best for:** Users who want broad functionality from some areas, plus specific tools from others. + +Enable entire toolsets, then add individual tools from toolsets you don't want fully enabled. + + + + + + + +
Remote ServerLocal Server
+ +```json +{ + "type": "http", + "url": "https://api.githubcopilot.com/mcp/", + "headers": { + "X-MCP-Toolsets": "repos,issues", + "X-MCP-Tools": "get_gist,pull_request_read" + } +} +``` + + + +```json +{ + "type": "stdio", + "command": "go", + "args": [ + "run", + "./cmd/github-mcp-server", + "stdio", + "--toolsets=repos,issues", + "--tools=get_gist,pull_request_read" + ], + "env": { + "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}" + } +} +``` + +
+ +**Result:** All repository and issue tools, plus just the gist tools you need. + +--- + +### Read-Only Mode + +**Best for:** Security conscious users that want to ensure the server won't allow operations that modify issues, pull requests, repositories etc. + +When active, this mode will disable all tools that are not read-only even if they were requested. + +**Example:** + + + + + + +
Remote ServerLocal Server
+ +**Option A: Header** +```json +{ + "type": "http", + "url": "https://api.githubcopilot.com/mcp/", + "headers": { + "X-MCP-Toolsets": "issues,repos,pull_requests", + "X-MCP-Readonly": "true" + } +} +``` + +**Option B: URL path** +```json +{ + "type": "http", + "url": "https://api.githubcopilot.com/mcp/x/all/readonly" +} +``` + + + + +```json +{ + "type": "stdio", + "command": "go", + "args": [ + "run", + "./cmd/github-mcp-server", + "stdio", + "--toolsets=issues,repos,pull_requests", + "--read-only" + ], + "env": { + "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}" + } +} +``` + +
+ +> Even if `issues` toolset contains `create_issue`, it will be excluded in read-only mode. + +--- + +### Dynamic Discovery (Local Only) + +**Best for:** Letting the LLM discover and enable toolsets as needed. + +Starts with only discovery tools (`enable_toolset`, `list_available_toolsets`, `get_toolset_tools`), then expands on demand. + + + + + + +
Local Server Only
+ +```json +{ + "type": "stdio", + "command": "go", + "args": [ + "run", + "./cmd/github-mcp-server", + "stdio", + "--dynamic-toolsets" + ], + "env": { + "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}" + } +} +``` + +**With some tools pre-enabled:** +```json +{ + "type": "stdio", + "command": "go", + "args": [ + "run", + "./cmd/github-mcp-server", + "stdio", + "--dynamic-toolsets", + "--tools=get_me,search_code" + ], + "env": { + "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}" + } +} +``` + +
+ +When both dynamic mode and specific tools are enabled in the server configuration, the server will start with the 3 dynamic tools + the specified tools. + +--- + +### Lockdown Mode + +**Best for:** Public repositories where you want to limit content from users without push access. + +Lockdown mode ensures the server only surfaces content in public repositories from users with push access to that repository. Private repositories are unaffected, and collaborators retain full access to their own content. + +**Example:** + + + + + + +
Remote ServerLocal Server
+ +```json +{ + "type": "http", + "url": "https://api.githubcopilot.com/mcp/", + "headers": { + "X-MCP-Lockdown": "true" + } +} +``` + + + +```json +{ + "type": "stdio", + "command": "go", + "args": [ + "run", + "./cmd/github-mcp-server", + "stdio", + "--lockdown-mode" + ], + "env": { + "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:github_token}" + } +} +``` + +
+ +--- + +## Troubleshooting + +| Problem | Cause | Solution | +|---------|-------|----------| +| Server fails to start | Invalid tool name in `--tools` or `X-MCP-Tools` | Check tool name spelling; use exact names from [Tools list](https://github.com/github/github-mcp-server?tab=readme-ov-file#tools) | +| Write tools not working | Read-only mode enabled | Remove `--read-only` flag or `X-MCP-Readonly` header | +| Tools missing | Toolset not enabled | Add the required toolset or specific tool | +| Dynamic tools not available | Using remote server | Dynamic mode is available in the local MCP server only | + +--- + +## Useful links + +- [README: Tool Configuration](https://github.com/github/github-mcp-server?tab=readme-ov-file#tool-configuration) — Full reference for toolsets, tools, and flags +- [README: Available Toolsets](https://github.com/github/github-mcp-server?tab=readme-ov-file#available-toolsets) — Complete list of toolsets +- [README: Tools](https://github.com/github/github-mcp-server?tab=readme-ov-file#tools) — Complete list of individual tools +- [Remote Server Documentation](https://github.com/github/github-mcp-server/blob/main/docs/remote-server.md) — Remote-specific options and headers +- [Installation Guides](https://github.com/github/github-mcp-server/tree/main/docs/installation-guides) — Host-specific setup instructions From ca9f1f1465e6c2f837a113b5d51240e674fc8bc8 Mon Sep 17 00:00:00 2001 From: tommaso-moro Date: Thu, 27 Nov 2025 16:40:00 +0000 Subject: [PATCH 04/13] update --- docs/server-configuration.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/server-configuration.md b/docs/server-configuration.md index ed398974d..fe5977323 100644 --- a/docs/server-configuration.md +++ b/docs/server-configuration.md @@ -21,10 +21,7 @@ We currently support the following ways in which the GitHub MCP Server can be co All configuration options are **composable**: you can combine toolsets, individual tools, dynamic discovery, read-only mode and lockdown mode in any way that suits your workflow. -For example: -- **Tools + Toolsets**: The server enables the union of both -- **Dynamic mode + Tools**: Start minimal with the tools you know you need, and discover more toolsets on demand -- **Read-Only Mode**: Acts as a strict security filter that takes precedence over any other configuration, by disabling write tools are excluded even if explicitly requested +Note: **read-only** mode acts as a strict security filter that takes precedence over any other configuration, by disabling write tools are excluded even when explicitly requested. --- From 55f5af289668ee86e389ae174bc4f28cce8bed10 Mon Sep 17 00:00:00 2001 From: Tommaso Moro <37270480+tommaso-moro@users.noreply.github.com> Date: Thu, 27 Nov 2025 17:16:11 +0000 Subject: [PATCH 05/13] Update docs/server-configuration.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/server-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/server-configuration.md b/docs/server-configuration.md index fe5977323..20d6a3dfa 100644 --- a/docs/server-configuration.md +++ b/docs/server-configuration.md @@ -171,7 +171,7 @@ Enable entire toolsets, then add individual tools from toolsets you don't want f ### Read-Only Mode -**Best for:** Security conscious users that want to ensure the server won't allow operations that modify issues, pull requests, repositories etc. +**Best for:** Security conscious users who want to ensure the server won't allow operations that modify issues, pull requests, repositories etc. When active, this mode will disable all tools that are not read-only even if they were requested. From dc1927af69602ed60e91d2a14671d830f82ff356 Mon Sep 17 00:00:00 2001 From: Tommaso Moro <37270480+tommaso-moro@users.noreply.github.com> Date: Fri, 28 Nov 2025 09:52:13 +0000 Subject: [PATCH 06/13] Update docs/remote-server.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/remote-server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/remote-server.md b/docs/remote-server.md index e1ea68d67..1030911ef 100644 --- a/docs/remote-server.md +++ b/docs/remote-server.md @@ -68,7 +68,7 @@ The Remote GitHub MCP server has optional headers equivalent to the Local server - Equivalent to `GITHUB_LOCKDOWN_MODE` 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. -> **Looking for examples?** See the [Server Configuration Guide](https://github.com/github/github-mcp-server/tree/main/docs/server-configuration.md) for common recipes like minimal setups, read-only mode, and combining tools with toolsets. +> **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. Example: From 17249db68575cbaee6721c045514835cb44663a5 Mon Sep 17 00:00:00 2001 From: Tommaso Moro <37270480+tommaso-moro@users.noreply.github.com> Date: Fri, 28 Nov 2025 09:52:19 +0000 Subject: [PATCH 07/13] Update docs/server-configuration.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/server-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/server-configuration.md b/docs/server-configuration.md index 20d6a3dfa..02bd21f90 100644 --- a/docs/server-configuration.md +++ b/docs/server-configuration.md @@ -346,5 +346,5 @@ Lockdown mode ensures the server only surfaces content in public repositories fr - [README: Tool Configuration](https://github.com/github/github-mcp-server?tab=readme-ov-file#tool-configuration) — Full reference for toolsets, tools, and flags - [README: Available Toolsets](https://github.com/github/github-mcp-server?tab=readme-ov-file#available-toolsets) — Complete list of toolsets - [README: Tools](https://github.com/github/github-mcp-server?tab=readme-ov-file#tools) — Complete list of individual tools -- [Remote Server Documentation](https://github.com/github/github-mcp-server/blob/main/docs/remote-server.md) — Remote-specific options and headers +- [Remote Server Documentation](./remote-server.md) — Remote-specific options and headers - [Installation Guides](https://github.com/github/github-mcp-server/tree/main/docs/installation-guides) — Host-specific setup instructions From 12dde1692340d7b690a72d2312e81d10b12f12e2 Mon Sep 17 00:00:00 2001 From: Tommaso Moro <37270480+tommaso-moro@users.noreply.github.com> Date: Fri, 28 Nov 2025 09:52:35 +0000 Subject: [PATCH 08/13] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 84af210e7..c9e724227 100644 --- a/README.md +++ b/README.md @@ -328,7 +328,7 @@ _Toolsets are not limited to Tools. Relevant MCP Resources and Prompts are also When no toolsets are specified, [default toolsets](#default-toolset) are used. -> **Looking for examples?** See the [Server Configuration Guide](https://github.com/github/github-mcp-server/tree/main/docs/server-configuration.md) for common recipes like minimal setups, read-only mode, and combining tools with toolsets. +> **Looking for examples?** See the [Server Configuration Guide](./docs/server-configuration.md) for common recipes like minimal setups, read-only mode, and combining tools with toolsets. #### Specifying Toolsets From 204922f29a6a277bc6bb0a1d9701cb6870b7d4a0 Mon Sep 17 00:00:00 2001 From: Tommaso Moro <37270480+tommaso-moro@users.noreply.github.com> Date: Fri, 28 Nov 2025 09:52:46 +0000 Subject: [PATCH 09/13] Update docs/server-configuration.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/server-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/server-configuration.md b/docs/server-configuration.md index 02bd21f90..80edf79b1 100644 --- a/docs/server-configuration.md +++ b/docs/server-configuration.md @@ -347,4 +347,4 @@ Lockdown mode ensures the server only surfaces content in public repositories fr - [README: Available Toolsets](https://github.com/github/github-mcp-server?tab=readme-ov-file#available-toolsets) — Complete list of toolsets - [README: Tools](https://github.com/github/github-mcp-server?tab=readme-ov-file#tools) — Complete list of individual tools - [Remote Server Documentation](./remote-server.md) — Remote-specific options and headers -- [Installation Guides](https://github.com/github/github-mcp-server/tree/main/docs/installation-guides) — Host-specific setup instructions +- [Installation Guides](./installation-guides) — Host-specific setup instructions From c5f6218664a7d177e307b1b6643694aeaacaa781 Mon Sep 17 00:00:00 2001 From: Tommaso Moro <37270480+tommaso-moro@users.noreply.github.com> Date: Fri, 28 Nov 2025 09:52:55 +0000 Subject: [PATCH 10/13] Update docs/server-configuration.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/server-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/server-configuration.md b/docs/server-configuration.md index 80edf79b1..60fa0a9e9 100644 --- a/docs/server-configuration.md +++ b/docs/server-configuration.md @@ -21,7 +21,7 @@ We currently support the following ways in which the GitHub MCP Server can be co All configuration options are **composable**: you can combine toolsets, individual tools, dynamic discovery, read-only mode and lockdown mode in any way that suits your workflow. -Note: **read-only** mode acts as a strict security filter that takes precedence over any other configuration, by disabling write tools are excluded even when explicitly requested. +Note: **read-only** mode acts as a strict security filter that takes precedence over any other configuration, by disabling write tools even when explicitly requested. --- From e317bffb14fa1d12695c330df7572151b2aa911a Mon Sep 17 00:00:00 2001 From: Tommaso Moro <37270480+tommaso-moro@users.noreply.github.com> Date: Fri, 28 Nov 2025 10:07:43 +0000 Subject: [PATCH 11/13] Update docs/server-configuration.md Co-authored-by: Tony Truong --- docs/server-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/server-configuration.md b/docs/server-configuration.md index 60fa0a9e9..c4110c39e 100644 --- a/docs/server-configuration.md +++ b/docs/server-configuration.md @@ -343,7 +343,7 @@ Lockdown mode ensures the server only surfaces content in public repositories fr ## Useful links -- [README: Tool Configuration](https://github.com/github/github-mcp-server?tab=readme-ov-file#tool-configuration) — Full reference for toolsets, tools, and flags +- [README: Tool Configuration](../README.md#tool-configuration) - [README: Available Toolsets](https://github.com/github/github-mcp-server?tab=readme-ov-file#available-toolsets) — Complete list of toolsets - [README: Tools](https://github.com/github/github-mcp-server?tab=readme-ov-file#tools) — Complete list of individual tools - [Remote Server Documentation](./remote-server.md) — Remote-specific options and headers From e86649b3e3ce2ba40181530f1fe0f556867583f2 Mon Sep 17 00:00:00 2001 From: tommaso-moro Date: Fri, 28 Nov 2025 10:12:43 +0000 Subject: [PATCH 12/13] use relative paths --- docs/server-configuration.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/server-configuration.md b/docs/server-configuration.md index c4110c39e..3e81d0c90 100644 --- a/docs/server-configuration.md +++ b/docs/server-configuration.md @@ -27,7 +27,7 @@ Note: **read-only** mode acts as a strict security filter that takes precedence ## Configuration Examples -The examples below use VS Code configuration format to illustrate the concepts. If you're using a different MCP host (Cursor, Claude Desktop, JetBrains, etc.), your configuration might need to look slightly different. See [installation guides](https://github.com/github/github-mcp-server/tree/main/docs/installation-guides) for host-specific setup. +The examples below use VS Code configuration format to illustrate the concepts. If you're using a different MCP host (Cursor, Claude Desktop, JetBrains, etc.), your configuration might need to look slightly different. See [installation guides](./installation-guides) for host-specific setup. ### Enabling Specific Tools @@ -334,7 +334,7 @@ Lockdown mode ensures the server only surfaces content in public repositories fr | Problem | Cause | Solution | |---------|-------|----------| -| Server fails to start | Invalid tool name in `--tools` or `X-MCP-Tools` | Check tool name spelling; use exact names from [Tools list](https://github.com/github/github-mcp-server?tab=readme-ov-file#tools) | +| Server fails to start | Invalid tool name in `--tools` or `X-MCP-Tools` | Check tool name spelling; use exact names from [Tools list](../README.md#tools) | | Write tools not working | Read-only mode enabled | Remove `--read-only` flag or `X-MCP-Readonly` header | | Tools missing | Toolset not enabled | Add the required toolset or specific tool | | Dynamic tools not available | Using remote server | Dynamic mode is available in the local MCP server only | @@ -344,7 +344,7 @@ Lockdown mode ensures the server only surfaces content in public repositories fr ## Useful links - [README: Tool Configuration](../README.md#tool-configuration) -- [README: Available Toolsets](https://github.com/github/github-mcp-server?tab=readme-ov-file#available-toolsets) — Complete list of toolsets -- [README: Tools](https://github.com/github/github-mcp-server?tab=readme-ov-file#tools) — Complete list of individual tools +- [README: Available Toolsets](../README.md#available-toolsets) — Complete list of toolsets +- [README: Tools](../README.md#tools) — Complete list of individual tools - [Remote Server Documentation](./remote-server.md) — Remote-specific options and headers - [Installation Guides](./installation-guides) — Host-specific setup instructions From c9b91fd56e04f76e1550436914d7ab13101822b3 Mon Sep 17 00:00:00 2001 From: tommaso-moro Date: Fri, 28 Nov 2025 10:13:52 +0000 Subject: [PATCH 13/13] use relative path --- docs/server-configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/server-configuration.md b/docs/server-configuration.md index 3e81d0c90..e8b7637bd 100644 --- a/docs/server-configuration.md +++ b/docs/server-configuration.md @@ -1,6 +1,6 @@ # Server Configuration Guide -This guide helps you choose the right configuration for your use case and shows you how to apply it. For the complete reference of available toolsets and tools, see the [README](https://github.com/github/github-mcp-server?tab=readme-ov-file#tool-configuration). +This guide helps you choose the right configuration for your use case and shows you how to apply it. For the complete reference of available toolsets and tools, see the [README](../README.md#tool-configuration). ## Quick Reference We currently support the following ways in which the GitHub MCP Server can be configured: