Skip to content

Commit c1e61b8

Browse files
authored
Add a Remote MCP configuration example that employs a PAT
1 parent 8562b1d commit c1e61b8

File tree

1 file changed

+38
-2
lines changed

1 file changed

+38
-2
lines changed

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ automation and interaction capabilities for developers and tools.
1212

1313
---
1414

15-
## Remote GitHub MCP Server
15+
# Remote GitHub MCP Server
1616

1717
[![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)
1818

@@ -32,6 +32,11 @@ For quick installation, use one of the one-click install buttons above. Once you
3232

3333
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:
3434

35+
<table>
36+
<tr><th>Using OAuth</th><th>Using a GitHub PAT</th></tr>
37+
<tr valign='top'>
38+
<td>
39+
3540
```json
3641
{
3742
"mcp": {
@@ -45,6 +50,37 @@ For MCP Hosts that have been [configured to use the remote GitHub MCP Server](do
4550
}
4651
```
4752

53+
</td>
54+
<td>
55+
56+
```json
57+
{
58+
"mcp": {
59+
"servers": {
60+
"github": {
61+
"type": "http",
62+
"url": "https://api.githubcopilot.com/mcp/"
63+
"headers": {
64+
"Authorization": "Bearer ${input:github_mcp_pat}",
65+
}
66+
}
67+
}
68+
},
69+
"inputs": [
70+
{
71+
"id": "github_mcp_pat",
72+
"type": "promptString",
73+
"description": "GitHub Personal Access Token",
74+
"password": true
75+
}
76+
]
77+
}
78+
```
79+
80+
</td>
81+
</tr>
82+
</table>
83+
4884
> **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.
4985
5086
### Configuration
@@ -53,7 +89,7 @@ See [Remote Server Documentation](docs/remote-server.md) on how to pass configur
5389

5490
---
5591

56-
## Local GitHub MCP Server
92+
# Local GitHub MCP Server
5793

5894
[![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)
5995

0 commit comments

Comments
 (0)