Skip to content

Add a Remote MCP configuration example that employs a PAT #514

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Jun 13, 2025
Merged

Add a Remote MCP configuration example that employs a PAT #514

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c1e61b8
Add a Remote MCP configuration example that employs a PAT
jww3 Jun 13, 2025
27b82d6
Fixed "Other MCP Hosts" example
jww3 Jun 13, 2025
ef8f612
Revert `<H1>`-related changes.
jww3 Jun 13, 2025
4a1cb43
fixed wording (pluralized)
jww3 Jun 13, 2025
04856da
Responded to PR feedback.
jww3 Jun 13, 2025
c7ff79b
Remove `MCP Host` column (for now).
jww3 Jun 13, 2025
ad1df84
Responded to PR feedback
jww3 Jun 13, 2025
d72a937
Remove Claude labelling
jww3 Jun 13, 2025
adef317
Tweak wording.
jww3 Jun 13, 2025
a86f3dd
Include `Bearer`
jww3 Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 38 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand All @@ -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:

<table>
<tr><th>Using OAuth</th><th>Using a GitHub PAT</th></tr>
<tr valign='top'>
<td>

```json
{
"mcp": {
Expand All @@ -45,6 +50,37 @@ For MCP Hosts that have been [configured to use the remote GitHub MCP Server](do
}
```

</td>
<td>

```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
}
]
}
```

</td>
</tr>
</table>

> **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
Expand All @@ -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)

Expand Down