Skip to content

Commit 48b1775

Browse files
authored
Update README.md
1 parent 73e8847 commit 48b1775

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ Built for developers who want to connect their AI tools to GitHub context and ca
2020

2121
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.
2222

23-
## Prerequisites
23+
### Prerequisites
2424

2525
1. A compatible MCP host with remote server support (VS Code 1.101+, Claude Desktop, Cursor, Windsurf, etc.)
2626
2. Any applicable [policies enabled](https://github.com/github/github-mcp-server/blob/main/docs/policies-and-governance.md)
2727

28-
## Install in VS Code
28+
### Install in VS Code
2929

3030
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.
3131

@@ -77,14 +77,17 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block
7777
</tr>
7878
</table>
7979

80-
## Install in other MCP hosts
80+
### Install in other MCP hosts
8181
- **[GitHub Copilot in other IDEs](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
8282
- **[Claude Applications](/docs/installation-guides/install-claude.md)** - Installation guide for Claude Web, Claude Desktop and Claude Code CLI
8383
- **[Cursor](/docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
8484
- **[Windsurf](/docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
8585

8686
> **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.
8787
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+
8891
> ⚠️ **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:
8992
> - OAuth: Subject to GitHub Copilot Editor Preview Policy until GA
9093
> - PAT: Controlled via your organization's PAT policies
@@ -96,7 +99,7 @@ Alternatively, to manually configure VS Code, choose the appropriate JSON block
9699

97100
[![Install with Docker in VS Code](https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](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) [![Install with Docker in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install_Server-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](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)
98101

99-
## Prerequisites
102+
### Prerequisites
100103

101104
1. To run the server in a container, you will need to have [Docker](https://www.docker.com/) installed.
102105
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
105108

106109
<details><summary><b>Handling PATs Securely</b></summary>
107110

108-
## Environment Variables (Recommended)
111+
### Environment Variables (Recommended)
109112
To keep your GitHub PAT secure and reusable across different MCP hosts:
110113

111114
1. **Store your PAT in environment variables**
@@ -136,7 +139,7 @@ To keep your GitHub PAT secure and reusable across different MCP hosts:
136139

137140
> **Note**: Environment variable support varies by host app and IDE. Some applications (like Windsurf) require hardcoded tokens in config files.
138141
139-
## Token Security Best Practices
142+
### Token Security Best Practices
140143

141144
- **Minimum scopes**: Only grant necessary permissions
142145
- `repo` - Repository operations
@@ -149,12 +152,6 @@ To keep your GitHub PAT secure and reusable across different MCP hosts:
149152
chmod 600 ~/.your-app/config.json
150153
```
151154

152-
## Required Scopes
153-
For GitHub MCP Server functionality, your PAT needs:
154-
- `repo` - Full repository access
155-
- `read:org` - Organization membership (if accessing org repos)
156-
- `workflow` - GitHub Actions access (if using workflow tools)
157-
158155
</details>
159156

160157
## Installation

0 commit comments

Comments
 (0)