You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ Hi there! We're thrilled that you'd like to contribute to this project. Your hel
8
8
9
9
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).
10
10
11
-
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
11
+
Please note that this project is released with a [Contributor Code of Conduct](https://github.com/github/github-mcp-server/blob/main/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
12
12
13
13
## What we're looking for
14
14
@@ -39,8 +39,8 @@ These are one time installations required to be able to test your changes locall
39
39
- Run linter: `script/lint`
40
40
- Update snapshots and run tests: `UPDATE_TOOLSNAPS=true go test ./...`
Copy file name to clipboardExpand all lines: README.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -80,20 +80,20 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block
80
80
</table>
81
81
82
82
### Install in other MCP hosts
83
-
-**[GitHub Copilot in other IDEs](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
84
-
-**[Claude Applications](/docs/installation-guides/install-claude.md)** - Installation guide for Claude Desktop and Claude Code CLI
85
-
-**[Codex](/docs/installation-guides/install-codex.md)** - Installation guide for Open AI Codex
86
-
-**[Cursor](/docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
87
-
-**[Windsurf](/docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
88
-
-**[Rovo Dev CLI](/docs/installation-guides/install-rovo-dev-cli.md)** - Installation guide for Rovo Dev CLI
83
+
-**[GitHub Copilot in other IDEs](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
84
+
-**[Claude Applications](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-claude.md)** - Installation guide for Claude Desktop and Claude Code CLI
85
+
-**[Codex](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-codex.md)** - Installation guide for Open AI Codex
86
+
-**[Cursor](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
87
+
-**[Windsurf](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
88
+
-**[Rovo Dev CLI](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-rovo-dev-cli.md)** - Installation guide for Rovo Dev CLI
89
89
90
90
> **Note:** Each MCP host application needs to configure a GitHub App or OAuth App to support remote access via OAuth. Any host application that supports remote MCP servers should support the remote GitHub server with PAT authentication. Configuration details and support levels vary by host. Make sure to refer to the host application's documentation for more info.
91
91
92
92
### Configuration
93
93
94
94
#### Toolset configuration
95
95
96
-
See [Remote Server Documentation](docs/remote-server.md) for full details on remote server configuration, toolsets, headers, and advanced usage. This file provides comprehensive instructions and examples for connecting, customizing, and installing the remote GitHub MCP Server in VS Code and other MCP hosts.
96
+
See [Remote Server Documentation](https://github.com/github/github-mcp-server/blob/main/docs/remote-server.md) for full details on remote server configuration, toolsets, headers, and advanced usage. This file provides comprehensive instructions and examples for connecting, customizing, and installing the remote GitHub MCP Server in VS Code and other MCP hosts.
97
97
98
98
When no toolsets are specified, [default toolsets](#default-toolset) are used.
99
99
@@ -297,13 +297,13 @@ Optionally, you can add a similar example (i.e. without the mcp key) to a file c
297
297
298
298
For other MCP host applications, please refer to our installation guides:
299
299
300
-
-**[GitHub Copilot in other IDEs](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
301
-
-**[Claude Code & Claude Desktop](docs/installation-guides/install-claude.md)** - Installation guide for Claude Code and Claude Desktop
302
-
-**[Cursor](docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
303
-
-**[Google Gemini CLI](docs/installation-guides/install-gemini-cli.md)** - Installation guide for Google Gemini CLI
304
-
-**[Windsurf](docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
300
+
-**[GitHub Copilot in other IDEs](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
301
+
-**[Claude Code & Claude Desktop](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-claude.md)** - Installation guide for Claude Code and Claude Desktop
302
+
-**[Cursor](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
303
+
-**[Google Gemini CLI](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-gemini-cli.md)** - Installation guide for Google Gemini CLI
304
+
-**[Windsurf](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
305
305
306
-
For a complete overview of all installation options, see our **[Installation Guides Index](docs/installation-guides)**.
306
+
For a complete overview of all installation options, see our **[Installation Guides Index](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides)**.
307
307
308
308
> **Note:** Any host application that supports local MCP servers should be able to access the local GitHub MCP server. However, the specific configuration process, syntax and stability of the integration will vary by host application. While many may follow a similar format to the examples above, this is not guaranteed. Please refer to your host application's documentation for the correct MCP configuration syntax and setup process.
309
309
@@ -336,7 +336,7 @@ _Toolsets are not limited to Tools. Relevant MCP Resources and Prompts are also
336
336
337
337
When no toolsets are specified, [default toolsets](#default-toolset) are used.
338
338
339
-
> **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.
339
+
> **Looking for examples?** See the [Server Configuration Guide](https://github.com/github/github-mcp-server/blob/main/docs/server-configuration.md) for common recipes like minimal setups, read-only mode, and combining tools with toolsets.
340
340
341
341
#### Specifying Toolsets
342
342
@@ -386,7 +386,7 @@ You can also configure specific tools using the `--tools` flag. Tools can be use
386
386
- Tools, toolsets, and dynamic toolsets can all be used together
387
387
- Read-only mode takes priority: write tools are skipped if `--read-only` is set, even if explicitly requested via `--tools`
388
388
- Tool names must match exactly (e.g., `get_file_contents`, not `getFileContents`). Invalid tool names will cause the server to fail at startup with an error message
389
-
- When tools are renamed, old names are preserved as aliases for backward compatibility. See [Deprecated Tool Aliases](docs/deprecated-tool-aliases.md) for details.
389
+
- When tools are renamed, old names are preserved as aliases for backward compatibility. See [Deprecated Tool Aliases](https://github.com/github/github-mcp-server/blob/main/docs/deprecated-tool-aliases.md) for details.
390
390
391
391
### Using Toolsets With Docker
392
392
@@ -1513,4 +1513,4 @@ The exported Go API of this module should currently be considered unstable, and
1513
1513
1514
1514
## License
1515
1515
1516
-
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](./LICENSE) for the full terms.
1516
+
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](https://github.com/github/github-mcp-server/blob/main/LICENSE) for the full terms.
Copy file name to clipboardExpand all lines: docs/installation-guides/README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,13 +3,13 @@
3
3
This directory contains detailed installation instructions for the GitHub MCP Server across different host applications and IDEs. Choose the guide that matches your development environment.
4
4
5
5
## Installation Guides by Host Application
6
-
-**[GitHub Copilot in other IDEs](install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
7
-
-**[Antigravity](install-antigravity.md)** - Installation for Google Antigravity IDE
8
-
-**[Claude Applications](install-claude.md)** - Installation guide for Claude Web, Claude Desktop and Claude Code CLI
9
-
-**[Cursor](install-cursor.md)** - Installation guide for Cursor IDE
10
-
-**[Google Gemini CLI](install-gemini-cli.md)** - Installation guide for Google Gemini CLI
11
-
-**[OpenAI Codex](install-codex.md)** - Installation guide for OpenAI Codex
12
-
-**[Windsurf](install-windsurf.md)** - Installation guide for Windsurf IDE
6
+
-**[GitHub Copilot in other IDEs](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
7
+
-**[Antigravity](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-antigravity.md)** - Installation for Google Antigravity IDE
8
+
-**[Claude Applications](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-claude.md)** - Installation guide for Claude Web, Claude Desktop and Claude Code CLI
9
+
-**[Cursor](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
10
+
-**[Google Gemini CLI](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-gemini-cli.md)** - Installation guide for Google Gemini CLI
11
+
-**[OpenAI Codex](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-codex.md)** - Installation guide for OpenAI Codex
12
+
-**[Windsurf](https://github.com/github/github-mcp-server/blob/main/docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
13
13
14
14
## Support by Host Application
15
15
@@ -88,7 +88,7 @@ If you encounter issues:
88
88
2. Verify your GitHub PAT has the required permissions
89
89
3. Ensure Docker is running (for local installations)
90
90
4. Review your host application's logs for error messages
91
-
5. Consult the main [README.md](README.md) for additional configuration options
91
+
5. Consult the main [README.md](https://github.com/github/github-mcp-server/blob/main/README.md) for additional configuration options
Copy file name to clipboardExpand all lines: docs/installation-guides/install-codex.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,7 +56,7 @@ After starting Codex (CLI or IDE):
56
56
57
57
## Usage
58
58
59
-
After setup, Codex can interact with GitHub directly. It will use the default tool set automatically but can be [configured](../../README.md#default-toolset). Try these example prompts:
59
+
After setup, Codex can interact with GitHub directly. It will use the default tool set automatically but can be [configured](https://github.com/github/github-mcp-server/blob/main/README.md#default-toolset). Try these example prompts:
60
60
61
61
**Repository Operations:**
62
62
- "List my GitHub repositories"
@@ -109,4 +109,4 @@ Use the principle of least privilege: add scopes only when a tool request fails
109
109
- Remote server URL: `https://api.githubcopilot.com/mcp/`
Copy file name to clipboardExpand all lines: docs/installation-guides/install-gemini-cli.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ MCP servers for Gemini CLI are configured in its settings JSON under an `mcpServ
28
28
29
29
After securely storing your PAT, you can add the GitHub MCP server configuration to your settings file using one of the methods below. You may need to restart the Gemini CLI for changes to take effect.
30
30
31
-
> **Note:** For the most up-to-date configuration options, see the [main README.md](../../README.md).
31
+
> **Note:** For the most up-to-date configuration options, see the [main README.md](https://github.com/github/github-mcp-server/blob/main/README.md).
Copy file name to clipboardExpand all lines: docs/installation-guides/install-other-copilot-ides.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Install GitHub MCP Server in Copilot IDEs
2
2
3
-
Quick setup guide for the GitHub MCP server in GitHub Copilot across different IDEs. For VS Code instructions, refer to the [VS Code install guide in the README](/README.md#installation-in-vs-code)
3
+
Quick setup guide for the GitHub MCP server in GitHub Copilot across different IDEs. For VS Code instructions, refer to the [VS Code install guide in the README](https://github.com/github/github-mcp-server/blob/main/README.md#installation-in-vs-code)
4
4
5
5
### Requirements:
6
6
-**GitHub Copilot License**: Any Copilot plan (Free, Pro, Pro+, Business, Enterprise) for Copilot access
Copy file name to clipboardExpand all lines: docs/remote-server.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,7 +68,7 @@ The Remote GitHub MCP server has optional headers equivalent to the Local server
68
68
- Equivalent to `GITHUB_LOCKDOWN_MODE` env var for Local server.
69
69
- 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.
70
70
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.
71
+
> **Looking for examples?** See the [Server Configuration Guide](https://github.com/github/github-mcp-server/blob/main/docs/server-configuration.md) for common recipes like minimal setups, read-only mode, and combining tools with toolsets.
72
72
73
73
Example:
74
74
@@ -88,7 +88,7 @@ Example:
88
88
89
89
The Remote GitHub MCP server supports the following URL path patterns:
90
90
91
-
-`/` - Default toolset (see ["default" toolset](../README.md#default-toolset))
91
+
-`/` - Default toolset (see ["default" toolset](https://github.com/github/github-mcp-server/blob/main/README.md#default-toolset))
92
92
-`/readonly` - Default toolset in read-only mode
93
93
-`/x/all` - All available toolsets
94
94
-`/x/all/readonly` - All available toolsets in read-only mode
Copy file name to clipboardExpand all lines: docs/scope-filtering.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ With OAuth, the remote server can dynamically request additional scopes as neede
24
24
25
25
## OAuth Scope Challenges (Remote Server)
26
26
27
-
When using the [remote MCP server](./remote-server.md) with OAuth authentication, the server uses a different approach called **scope challenges**. Instead of hiding tools upfront, all tools are available, and the server requests additional scopes on-demand when you try to use a tool that requires them.
27
+
When using the [remote MCP server](https://github.com/github/github-mcp-server/blob/main/docs/remote-server.md) with OAuth authentication, the server uses a different approach called **scope challenges**. Instead of hiding tools upfront, all tools are available, and the server requests additional scopes on-demand when you try to use a tool that requires them.
28
28
29
29
**How it works:**
30
30
1. You attempt to use a tool (e.g., creating an issue)
@@ -58,7 +58,7 @@ Some scopes implicitly include others:
58
58
59
59
This means if your token has `repo`, tools requiring `security_events` will also be available.
60
60
61
-
Each tool in the [README](../README.md#tools) lists its required and accepted OAuth scopes.
61
+
Each tool in the [README](https://github.com/github/github-mcp-server/blob/main/README.md#tools) lists its required and accepted OAuth scopes.
62
62
63
63
## Public Repository Access
64
64
@@ -98,6 +98,6 @@ WARN: failed to fetch token scopes, continuing without scope filtering
0 commit comments