Skip to content

Commit a805b90

Browse files
authored
Merge branch 'main' into tonytrg/update-readme
2 parents 544ab4a + e9926b9 commit a805b90

File tree

1 file changed

+77
-8
lines changed

1 file changed

+77
-8
lines changed

README.md

Lines changed: 77 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,28 +28,97 @@ The remote GitHub MCP Server is hosted by GitHub and provides the easiest method
2828

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

31-
### Usage in other MCP Hosts
3231

33-
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:
32+
Alternatively, to manually configure VS Code, choose the appropriate JSON block from the examples below and add it to your host configuration:
3433

34+
<table>
35+
<tr><th>Using OAuth</th><th>Using a GitHub PAT</th></tr>
36+
<tr><th align=left colspan=2>VS Code (version 1.101 or greater)</th></tr>
37+
<tr valign=top>
38+
<td>
39+
3540
```json
3641
{
37-
"mcp": {
38-
"servers": {
39-
"github": {
40-
"type": "http",
41-
"url": "https://api.githubcopilot.com/mcp/"
42+
"servers": {
43+
"github-remote": {
44+
"type": "http",
45+
"url": "https://api.githubcopilot.com/mcp/"
46+
}
47+
}
48+
}
49+
```
50+
51+
</td>
52+
<td>
53+
54+
```json
55+
{
56+
"servers": {
57+
"github-remote": {
58+
"type": "http",
59+
"url": "https://api.githubcopilot.com/mcp/",
60+
"headers": {
61+
"Authorization": "Bearer ${input:github_mcp_pat}",
4262
}
4363
}
64+
},
65+
"inputs": [
66+
{
67+
"type": "promptString",
68+
"id": "github_mcp_pat",
69+
"description": "GitHub Personal Access Token",
70+
"password": true
71+
}
72+
]
73+
}
74+
```
75+
76+
</td>
77+
</tr>
78+
</table>
79+
80+
### Usage in other MCP Hosts
81+
82+
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:
83+
84+
<table>
85+
<tr><th>Using OAuth</th><th>Using a GitHub PAT</th></tr>
86+
<tr valign=top>
87+
<td>
88+
89+
```json
90+
{
91+
"mcpServers": {
92+
"github-remote": {
93+
"url": "https://api.githubcopilot.com/mcp/"
94+
}
4495
}
4596
}
4697
```
4798

99+
</td>
100+
<td>
101+
102+
```json
103+
{
104+
"mcpServers": {
105+
"github-remote": {
106+
"url": "https://api.githubcopilot.com/mcp/",
107+
"authorization_token": "Bearer <your GitHub PAT>"
108+
}
109+
}
110+
}
111+
```
112+
113+
</td>
114+
</tr>
115+
</table>
116+
48117
> **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.
49118
50119
### Configuration
51120

52-
See [Remote Server Documentation](docs/remote-server.md) on how to pass configuration settings to the remote GitHub MCP Server.
121+
See [Remote Server Documentation](docs/remote-server.md) on how to pass additional configuration settings to the remote GitHub MCP Server.
53122

54123
---
55124

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

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:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy