diff --git a/README.md b/README.md index a8d5b2552..d40d8aab3 100644 --- a/README.md +++ b/README.md @@ -28,28 +28,97 @@ The remote GitHub MCP Server is hosted by GitHub and provides the easiest method 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. -### Usage in other MCP Hosts -For MCP Hosts that have been [configured to use the remote GitHub MCP Server](docs/host-integration.md), add the following JSON block to the host's configuration: +Alternatively, to manually configure VS Code, choose the appropriate JSON block from the examples below and add it to your host configuration: +
Using OAuth | Using a GitHub PAT |
---|---|
VS Code (version 1.101 or greater) | |
+ ```json { - "mcp": { - "servers": { - "github": { - "type": "http", - "url": "https://api.githubcopilot.com/mcp/" + "servers": { + "github-remote": { + "type": "http", + "url": "https://api.githubcopilot.com/mcp/" + } + } +} +``` + + | ++ +```json +{ + "servers": { + "github-remote": { + "type": "http", + "url": "https://api.githubcopilot.com/mcp/", + "headers": { + "Authorization": "Bearer ${input:github_mcp_pat}", } } + }, + "inputs": [ + { + "type": "promptString", + "id": "github_mcp_pat", + "description": "GitHub Personal Access Token", + "password": true + } + ] +} +``` + + | +
Using OAuth | Using a GitHub PAT |
---|---|
+ +```json +{ + "mcpServers": { + "github-remote": { + "url": "https://api.githubcopilot.com/mcp/" + } } } ``` + | +
+
+```json
+{
+ "mcpServers": {
+ "github-remote": {
+ "url": "https://api.githubcopilot.com/mcp/",
+ "authorization_token": "Bearer |
+
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies: