From c1e61b8a70434aea9b8c982fbefd0c805919f486 Mon Sep 17 00:00:00 2001 From: John Wesley Walker III <81404201+jww3@users.noreply.github.com> Date: Fri, 13 Jun 2025 16:16:07 +0200 Subject: [PATCH 01/11] Add a Remote MCP configuration example that employs a PAT --- README.md | 40 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a8d5b255..3d0acf04 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ automation and interaction capabilities for developers and tools. --- -## Remote GitHub MCP Server +# Remote GitHub MCP Server [![Install 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&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2F%22%7D) [![Install 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&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2F%22%7D&quality=insiders) @@ -32,6 +32,11 @@ For quick installation, use one of the one-click install buttons above. Once you 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: + + + + + + +
Using OAuthUsing a GitHub PAT
+ ```json { "mcp": { @@ -45,6 +50,37 @@ For MCP Hosts that have been [configured to use the remote GitHub MCP Server](do } ``` + + +```json +{ + "mcp": { + "servers": { + "github": { + "type": "http", + "url": "https://api.githubcopilot.com/mcp/" + "headers": { + "Authorization": "Bearer ${input:github_mcp_pat}", + } + } + } + }, + "inputs": [ + { + "id": "github_mcp_pat", + "type": "promptString", + "description": "GitHub Personal Access Token", + "password": true + } + ] +} +``` + +
+ > **Note:** The exact configuration format may vary by host. Refer to your host's documentation for the correct syntax and location for remote MCP server setup. ### Configuration @@ -53,7 +89,7 @@ See [Remote Server Documentation](docs/remote-server.md) on how to pass configur --- -## Local GitHub MCP Server +# Local GitHub MCP Server [![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) From 27b82d6a423eeff7925727b78b93a6d2f7184209 Mon Sep 17 00:00:00 2001 From: John Wesley Walker III <81404201+jww3@users.noreply.github.com> Date: Fri, 13 Jun 2025 16:58:51 +0200 Subject: [PATCH 02/11] Fixed "Other MCP Hosts" example --- README.md | 32 ++++++++------------------------ 1 file changed, 8 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 3d0acf04..0df3dc84 100644 --- a/README.md +++ b/README.md @@ -39,12 +39,9 @@ For MCP Hosts that have been [configured to use the remote GitHub MCP Server](do ```json { - "mcp": { - "servers": { - "github": { - "type": "http", - "url": "https://api.githubcopilot.com/mcp/" - } + "mcpServers": { + "github": { + "url": "https://api.githubcopilot.com/mcp/" } } } @@ -55,25 +52,12 @@ For MCP Hosts that have been [configured to use the remote GitHub MCP Server](do ```json { - "mcp": { - "servers": { - "github": { - "type": "http", - "url": "https://api.githubcopilot.com/mcp/" - "headers": { - "Authorization": "Bearer ${input:github_mcp_pat}", - } - } - } - }, - "inputs": [ - { - "id": "github_mcp_pat", - "type": "promptString", - "description": "GitHub Personal Access Token", - "password": true + "mcpServers": { + "github": { + "url": "https://api.githubcopilot.com/mcp/", + "authorization_token": "" } - ] + } } ``` From ef8f612c4743997b774acacd74b1b056ef62b59f Mon Sep 17 00:00:00 2001 From: John Wesley Walker III <81404201+jww3@users.noreply.github.com> Date: Fri, 13 Jun 2025 17:00:53 +0200 Subject: [PATCH 03/11] Revert `

`-related changes. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0df3dc84..9260cdc9 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ automation and interaction capabilities for developers and tools. --- -# Remote GitHub MCP Server +## Remote GitHub MCP Server [![Install 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&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2F%22%7D) [![Install 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&config=%7B%22type%22%3A%20%22http%22%2C%22url%22%3A%20%22https%3A%2F%2Fapi.githubcopilot.com%2Fmcp%2F%22%7D&quality=insiders) @@ -73,7 +73,7 @@ See [Remote Server Documentation](docs/remote-server.md) on how to pass configur --- -# Local GitHub MCP Server +## Local GitHub MCP Server [![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) From 4a1cb43ce74dcfee65616dfca21e7292f9648f7a Mon Sep 17 00:00:00 2001 From: John Wesley Walker III <81404201+jww3@users.noreply.github.com> Date: Fri, 13 Jun 2025 17:11:18 +0200 Subject: [PATCH 04/11] fixed wording (pluralized) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9260cdc9..26d29fda 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ For quick installation, use one of the one-click install buttons above. Once you ### 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: +For MCP Hosts that have been [configured to use the remote GitHub MCP Server](docs/host-integration.md), choose the appropriate JSON block from the examples below and add it to the host's configuration: From 04856da2c5edde4389efe177f057f19010f72040 Mon Sep 17 00:00:00 2001 From: John Wesley Walker III <81404201+jww3@users.noreply.github.com> Date: Fri, 13 Jun 2025 18:35:22 +0200 Subject: [PATCH 05/11] Responded to PR feedback. --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 26d29fda..9d338890 100644 --- a/README.md +++ b/README.md @@ -30,11 +30,12 @@ For quick installation, use one of the one-click install buttons above. Once you ### Usage in other MCP Hosts -For MCP Hosts that have been [configured to use the remote GitHub MCP Server](docs/host-integration.md), choose the appropriate JSON block from the examples below and add it to the host's configuration: +For MCP Hosts that are [Remote MCP-compatible](docs/host-integration.md), choose the appropriate JSON block from the examples below and add it to your host configuration:
Using OAuthUsing a GitHub PAT
- + +
Using OAuthUsing a GitHub PAT
MCP HostUsing OAuthUsing a GitHub PAT
Claude Desktop ```json @@ -69,7 +70,7 @@ For MCP Hosts that have been [configured to use the remote GitHub MCP Server](do ### Configuration -See [Remote Server Documentation](docs/remote-server.md) on how to pass configuration settings to the remote GitHub MCP Server. +See [Remote Server Documentation](docs/remote-server.md) on how to pass additional configuration settings to the remote GitHub MCP Server. --- From c7ff79b73bfb2af641d75a3d36c2806982726c5a Mon Sep 17 00:00:00 2001 From: John Wesley Walker III <81404201+jww3@users.noreply.github.com> Date: Fri, 13 Jun 2025 18:38:13 +0200 Subject: [PATCH 06/11] Remove `MCP Host` column (for now). --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 9d338890..9180ea7a 100644 --- a/README.md +++ b/README.md @@ -33,9 +33,8 @@ For quick installation, use one of the one-click install buttons above. Once you For MCP Hosts that are [Remote MCP-compatible](docs/host-integration.md), choose the appropriate JSON block from the examples below and add it to your host configuration: - + -
MCP HostUsing OAuthUsing a GitHub PAT
Using OAuthUsing a GitHub PAT
Claude Desktop ```json From ad1df8466f621b741e76e525f4fa8317c99eda4d Mon Sep 17 00:00:00 2001 From: John Wesley Walker III <81404201+jww3@users.noreply.github.com> Date: Fri, 13 Jun 2025 18:55:15 +0200 Subject: [PATCH 07/11] Responded to PR feedback --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9180ea7a..d0b4f820 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,8 @@ For MCP Hosts that are [Remote MCP-compatible](docs/host-integration.md), choose - + +
Using OAuthUsing a GitHub PAT
Claude Desktop
```json From d72a93717242930ab18569cc5f13fe1ca05c63b6 Mon Sep 17 00:00:00 2001 From: John Wesley Walker III <81404201+jww3@users.noreply.github.com> Date: Fri, 13 Jun 2025 19:27:43 +0200 Subject: [PATCH 08/11] Remove Claude labelling Claude may not yet support GitHub OAuth fully. --- README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 51 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d0b4f820..453bf046 100644 --- a/README.md +++ b/README.md @@ -28,20 +28,68 @@ 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. + +To manually configure VS Code, choose the appropriate JSON block from the examples below and add it to your host configuration: + + + + + + + + +
Using OAuthUsing a GitHub PAT
VS Code (version 1.101 or greater)
+ +```json +{ + "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 + } + ] +} +``` + +
+ ### Usage in other MCP Hosts For MCP Hosts that are [Remote MCP-compatible](docs/host-integration.md), choose the appropriate JSON block from the examples below and add it to your host configuration: -
Using OAuthUsing a GitHub PAT
Claude Desktop
```json { "mcpServers": { - "github": { + "github-remote": { "url": "https://api.githubcopilot.com/mcp/" } } @@ -54,7 +102,7 @@ For MCP Hosts that are [Remote MCP-compatible](docs/host-integration.md), choose ```json { "mcpServers": { - "github": { + "github-remote": { "url": "https://api.githubcopilot.com/mcp/", "authorization_token": "" } From adef317d4f7a31bf5c3f0c9c1562645b4f1ee7da Mon Sep 17 00:00:00 2001 From: John Wesley Walker III <81404201+jww3@users.noreply.github.com> Date: Fri, 13 Jun 2025 19:28:36 +0200 Subject: [PATCH 09/11] Tweak wording. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 453bf046..6cdf46f3 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ 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. -To manually configure VS Code, choose the appropriate JSON block from the examples below and add it to your host configuration: +Alternatively, to manually configure VS Code, choose the appropriate JSON block from the examples below and add it to your host configuration: From a86f3dd3a24d8974691704cec24c1e1e5367ddd0 Mon Sep 17 00:00:00 2001 From: John Wesley Walker III <81404201+jww3@users.noreply.github.com> Date: Fri, 13 Jun 2025 19:32:11 +0200 Subject: [PATCH 10/11] Include `Bearer` --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6cdf46f3..d40d8aab 100644 --- a/README.md +++ b/README.md @@ -104,7 +104,7 @@ For MCP Hosts that are [Remote MCP-compatible](docs/host-integration.md), choose "mcpServers": { "github-remote": { "url": "https://api.githubcopilot.com/mcp/", - "authorization_token": "" + "authorization_token": "Bearer " } } } From 44f5e8bfaaf3fd7613d8ecdf59df014e85b65cdb Mon Sep 17 00:00:00 2001 From: John Wesley Walker III <81404201+jww3@users.noreply.github.com> Date: Fri, 13 Jun 2025 19:33:36 +0200 Subject: [PATCH 11/11] Label Claude Desktop Config merge once Claude Desktop fully supports GitHub OAuth --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index d40d8aab..7f1b3158 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,7 @@ For MCP Hosts that are [Remote MCP-compatible](docs/host-integration.md), choose
Using OAuthUsing a GitHub PAT
+
Using OAuthUsing a GitHub PAT
Claude Desktop