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: README.md
+9-12Lines changed: 9 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,12 +20,12 @@ Built for developers who want to connect their AI tools to GitHub context and ca
20
20
21
21
The remote GitHub MCP Server is hosted by GitHub and provides the easiest method for getting up and running. If your MCP host does not support remote MCP servers, don't worry! You can use the [local version of the GitHub MCP Server](https://github.com/github/github-mcp-server?tab=readme-ov-file#local-github-mcp-server) instead.
22
22
23
-
## Prerequisites
23
+
###Prerequisites
24
24
25
25
1. A compatible MCP host with remote server support (VS Code 1.101+, Claude Desktop, Cursor, Windsurf, etc.)
26
26
2. Any applicable [policies enabled](https://github.com/github/github-mcp-server/blob/main/docs/policies-and-governance.md)
27
27
28
-
## Install in VS Code
28
+
###Install in VS Code
29
29
30
30
For quick installation, use one of the one-click install buttons above. Once you complete that flow, toggle Agent mode (located by the Copilot Chat text input) and the server will start. Make sure you're using [VS Code 1.101](https://code.visualstudio.com/updates/v1_101) or [later](https://code.visualstudio.com/updates) for remote MCP and OAuth support.
31
31
@@ -77,14 +77,17 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block
77
77
</tr>
78
78
</table>
79
79
80
-
## Install in other MCP hosts
80
+
###Install in other MCP hosts
81
81
-**[GitHub Copilot in other IDEs](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
82
82
-**[Claude Applications](/docs/installation-guides/install-claude.md)** - Installation guide for Claude Web, Claude Desktop and Claude Code CLI
83
83
-**[Cursor](/docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
84
84
-**[Windsurf](/docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
85
85
86
86
> **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.
87
87
88
+
### Configuration
89
+
See [Remote Server Documentation](/docs/remote-server.md) on how to pass additional configuration settings to the remote GitHub MCP Server.
90
+
88
91
> ⚠️ **Public Preview Status:** The **remote** GitHub MCP Server is currently in Public Preview. During preview, access may be gated depending on authentication type and surface:
89
92
> - OAuth: Subject to GitHub Copilot Editor Preview Policy until GA
90
93
> - PAT: Controlled via your organization's PAT policies
@@ -96,7 +99,7 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block
96
99
97
100
[](https://insiders.vscode.dev/redirect/mcp/install?name=github&inputs=%5B%7B%22id%22%3A%22github_token%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22GitHub%20Personal%20Access%20Token%22%2C%22password%22%3Atrue%7D%5D&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22--rm%22%2C%22-e%22%2C%22GITHUB_PERSONAL_ACCESS_TOKEN%22%2C%22ghcr.io%2Fgithub%2Fgithub-mcp-server%22%5D%2C%22env%22%3A%7B%22GITHUB_PERSONAL_ACCESS_TOKEN%22%3A%22%24%7Binput%3Agithub_token%7D%22%7D%7D) [](https://insiders.vscode.dev/redirect/mcp/install?name=github&inputs=%5B%7B%22id%22%3A%22github_token%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22GitHub%20Personal%20Access%20Token%22%2C%22password%22%3Atrue%7D%5D&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22--rm%22%2C%22-e%22%2C%22GITHUB_PERSONAL_ACCESS_TOKEN%22%2C%22ghcr.io%2Fgithub%2Fgithub-mcp-server%22%5D%2C%22env%22%3A%7B%22GITHUB_PERSONAL_ACCESS_TOKEN%22%3A%22%24%7Binput%3Agithub_token%7D%22%7D%7D&quality=insiders)
98
101
99
-
## Prerequisites
102
+
###Prerequisites
100
103
101
104
1. To run the server in a container, you will need to have [Docker](https://www.docker.com/) installed.
102
105
2. Once Docker is installed, you will also need to ensure Docker is running. The image is public; if you get errors on pull, you may have an expired token and need to `docker logout ghcr.io`.
@@ -105,7 +108,7 @@ The MCP server can use many of the GitHub APIs, so enable the permissions that y
105
108
106
109
<details><summary><b>Handling PATs Securely</b></summary>
107
110
108
-
## Environment Variables (Recommended)
111
+
###Environment Variables (Recommended)
109
112
To keep your GitHub PAT secure and reusable across different MCP hosts:
110
113
111
114
1.**Store your PAT in environment variables**
@@ -136,7 +139,7 @@ To keep your GitHub PAT secure and reusable across different MCP hosts:
136
139
137
140
> **Note**: Environment variable support varies by host app and IDE. Some applications (like Windsurf) require hardcoded tokens in config files.
138
141
139
-
## Token Security Best Practices
142
+
###Token Security Best Practices
140
143
141
144
-**Minimum scopes**: Only grant necessary permissions
142
145
-`repo` - Repository operations
@@ -149,12 +152,6 @@ To keep your GitHub PAT secure and reusable across different MCP hosts:
149
152
chmod 600 ~/.your-app/config.json
150
153
```
151
154
152
-
## Required Scopes
153
-
For GitHub MCP Server functionality, your PAT needs:
0 commit comments