Skip to content

Commit 7ccec07

Browse files
D1M1TR10SD1M1TR10S
authored
Update install-other-copilot-ides.md
1 parent 0142964 commit 7ccec07

1 file changed

Lines changed: 80 additions & 71 deletions

File tree

‎docs/installation-guides/install-other-copilot-ides.md‎

Lines changed: 80 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -4,51 +4,55 @@ Quick setup guide for the GitHub Model Context Protocol (MCP) server across diff
44

55
## Important Prerequisites
66

7-
- **Organization Policy**: To use GitHub Copilot with the _Remote_ GitHub MCP Server via OAuth, your organization must enable the Editor Preview Policy while MCP support remains in public preview
87
- **Authentication Methods**:
98
- VS Code supports both OAuth and PAT for remote servers
10-
- Copilot in all other IDEs (Visual Studio, JetBrains, Xcode, Eclipse) currently supports PAT-only for the remote server
11-
- Copilot in all IDEs supports local server installation with PAT authentication
9+
- Copilot in all other IDEs (Visual Studio, JetBrains, Xcode, Eclipse) currently supports PAT-only for the remote and local servers
1210

1311
---
1412

1513
## Important Notes on GitHub MCP Server
1614

17-
- **Official Migration**: The GitHub MCP server has migrated to GitHub's official repository at [github/github-mcp-server](https://github.com/github/github-mcp-server)
1815
- **Docker Image**: The official Docker image is now `ghcr.io/github/github-mcp-server`
1916
- **npm Package**: The npm package `@modelcontextprotocol/server-github` is still maintained but includes a deprecation notice
20-
- **Remote Server**: The remote server URL remains `https://api.githubcopilot.com/mcp/`
17+
- **Remote Server**: The remote server URL is `https://api.githubcopilot.com/mcp/`
2118

2219
---
20+
# GitHub MCP Server Installation Guide
21+
22+
Quick setup guide for the GitHub MCP server in GitHub Copilot across different IDEs. For VS Code instructions, refer to the [VS Code install guide in the README](/README.md#installation-in-vs-code)
2323

2424
## Visual Studio Setup
2525

26-
Requires Visual Studio 2022 version 17.14 or later. Visual Studio supports both remote and local GitHub MCP server configurations.
26+
Requires Visual Studio 2022 version 17.14 or later.
2727

28-
### Remote Server Configuration (PAT Only)
29-
Visual Studio currently supports PAT authentication only for remote MCP servers.
28+
### Remote Server (Recommended)
3029

31-
1. Create an `.mcp.json` file in your solution directory
30+
The remote GitHub MCP server is hosted by GitHub and provides automatic updates with no local setup required.
31+
32+
**Note**: OAuth authentication is not yet supported in Visual Studio. You must use a Personal Access Token (PAT).
33+
34+
#### Configuration
35+
1. Go to **Tools** → **Options** → **GitHub** → **Copilot** → **MCP Servers**
3236
2. Add this configuration:
3337
```json
3438
{
3539
"servers": {
3640
"github": {
37-
"type": "http",
3841
"url": "https://api.githubcopilot.com/mcp/",
39-
"headers": {
40-
"Authorization": "Bearer YOUR_GITHUB_PAT"
41-
}
42+
"authorization_token": "Bearer YOUR_GITHUB_PAT"
4243
}
4344
}
4445
}
4546
```
46-
3. Save the file and restart Visual Studio
47-
4. Open Agent Mode in Copilot Chat to access MCP tools
47+
3. Restart Visual Studio
4848

49-
### Local Server Configuration
50-
Requires Docker installed and running.
49+
### Local Server
5150

51+
For users who prefer to run the GitHub MCP server locally. Requires Docker installed and running.
52+
53+
#### Configuration
54+
1. Create an `.mcp.json` file in your solution directory
55+
2. Add this configuration:
5256
```json
5357
{
5458
"inputs": [
@@ -74,6 +78,7 @@ Requires Docker installed and running.
7478
}
7579
}
7680
```
81+
3. Save the file and restart Visual Studio
7782

7883
**Documentation:** [Visual Studio MCP Guide](https://learn.microsoft.com/en-us/visualstudio/ide/mcp-servers?view=vs-2022)
7984

@@ -83,7 +88,13 @@ Requires Docker installed and running.
8388

8489
Agent mode and MCP support available in public preview across IntelliJ IDEA, PyCharm, WebStorm, and other JetBrains IDEs.
8590

86-
### Remote Server Configuration (PAT Only)
91+
### Remote Server (Recommended)
92+
93+
The remote GitHub MCP server is hosted by GitHub and provides automatic updates with no local setup required.
94+
95+
**Note**: OAuth authentication is not yet supported in JetBrains IDEs. You must use a Personal Access Token (PAT).
96+
97+
#### Configuration Steps
8798
1. Install/update the GitHub Copilot plugin
8899
2. Click **GitHub Copilot icon** → **Edit Settings** → **MCP Servers** → **Edit in mcp.json**
89100
3. Add configuration:
@@ -103,10 +114,11 @@ Agent mode and MCP support available in public preview across IntelliJ IDEA, PyC
103114
```
104115
4. Restart IDE and use Agent mode in Copilot Chat
105116

106-
### Local Server Configuration
117+
### Local Server
118+
119+
For users who prefer to run the GitHub MCP server locally. Requires Docker installed and running.
107120

108-
#### Option 1: Using Docker (Recommended)
109-
Requires Docker installed and running.
121+
#### Configuration
110122
```json
111123
{
112124
"servers": {
@@ -125,31 +137,21 @@ Requires Docker installed and running.
125137
}
126138
```
127139

128-
#### Option 2: Using npx
129-
Note: The npm package `@modelcontextprotocol/server-github` has moved to GitHub's official repository but is still functional.
130-
```json
131-
{
132-
"servers": {
133-
"github": {
134-
"command": "npx",
135-
"args": ["-y", "@modelcontextprotocol/server-github"],
136-
"env": {
137-
"GITHUB_PERSONAL_ACCESS_TOKEN": "YOUR_GITHUB_PAT"
138-
}
139-
}
140-
}
141-
}
142-
```
143-
144-
**Documentation:** [Copilot Plugin for JetBrains IDEs](https://plugins.jetbrains.com/plugin/17718-github-copilot)
140+
**Documentation:** [JetBrains Copilot Guide](https://plugins.jetbrains.com/plugin/17718-github-copilot)
145141

146142
---
147143

148144
## Xcode Setup
149145

150146
Agent mode and MCP support now available in public preview for Xcode.
151147

152-
### Remote Server Configuration (PAT Only)
148+
### Remote Server (Recommended)
149+
150+
The remote GitHub MCP server is hosted by GitHub and provides automatic updates with no local setup required.
151+
152+
**Note**: OAuth authentication is not yet supported in Xcode. You must use a Personal Access Token (PAT).
153+
154+
#### Configuration Steps
153155
1. Install/update [GitHub Copilot for Xcode](https://github.com/github/CopilotForXcode)
154156
2. Open **GitHub Copilot for Xcode app** → **Agent Mode** → **🛠️ Tool Picker** → **Edit Config**
155157
3. Configure your MCP servers:
@@ -168,10 +170,11 @@ Agent mode and MCP support now available in public preview for Xcode.
168170
}
169171
```
170172

171-
### Local Server Configuration
173+
### Local Server
174+
175+
For users who prefer to run the GitHub MCP server locally. Requires Docker installed and running.
172176

173-
#### Option 1: Using Docker (Recommended)
174-
Requires Docker installed and running.
177+
#### Configuration
175178
```json
176179
{
177180
"servers": {
@@ -190,22 +193,6 @@ Requires Docker installed and running.
190193
}
191194
```
192195

193-
#### Option 2: Using npx
194-
Note: The npm package `@modelcontextprotocol/server-github` has moved to GitHub's official repository but is still functional.
195-
```json
196-
{
197-
"servers": {
198-
"github": {
199-
"command": "npx",
200-
"args": ["-y", "@modelcontextprotocol/server-github"],
201-
"env": {
202-
"GITHUB_PERSONAL_ACCESS_TOKEN": "YOUR_GITHUB_PAT"
203-
}
204-
}
205-
}
206-
}
207-
```
208-
209196
**Documentation:** [Xcode Copilot Guide](https://devblogs.microsoft.com/xcode/github-copilot-exploring-agent-mode-and-mcp-support-in-public-preview-for-xcode/)
210197

211198
---
@@ -214,7 +201,13 @@ Note: The npm package `@modelcontextprotocol/server-github` has moved to GitHub'
214201

215202
MCP support available with Eclipse 2024-09+ and latest GitHub Copilot extension.
216203

217-
### Remote Server Configuration (PAT Only)
204+
### Remote Server (Recommended)
205+
206+
The remote GitHub MCP server is hosted by GitHub and provides automatic updates with no local setup required.
207+
208+
**Note**: OAuth authentication is not yet supported in Eclipse. You must use a Personal Access Token (PAT).
209+
210+
#### Configuration Steps
218211
1. Install GitHub Copilot extension from Eclipse Marketplace
219212
2. Click **GitHub Copilot icon** → **Edit Preferences** → **MCP Servers**
220213
3. Add GitHub MCP server configuration:
@@ -234,16 +227,36 @@ MCP support available with Eclipse 2024-09+ and latest GitHub Copilot extension.
234227
```
235228
4. Restart Eclipse
236229

237-
### Local Server Configuration
238-
Eclipse supports local MCP server installation using Docker or npx, following the same configuration patterns as shown in the JetBrains section above.
230+
### Local Server
231+
232+
For users who prefer to run the GitHub MCP server locally. Requires Docker installed and running.
233+
234+
#### Configuration
235+
```json
236+
{
237+
"servers": {
238+
"github": {
239+
"command": "docker",
240+
"args": [
241+
"run", "-i", "--rm",
242+
"-e", "GITHUB_PERSONAL_ACCESS_TOKEN",
243+
"ghcr.io/github/github-mcp-server"
244+
],
245+
"env": {
246+
"GITHUB_PERSONAL_ACCESS_TOKEN": "YOUR_GITHUB_PAT"
247+
}
248+
}
249+
}
250+
}
251+
```
239252

240253
**Documentation:** [Eclipse Copilot Extension](https://marketplace.eclipse.org/content/github-copilot)
241254

242255
---
243256

244257
## GitHub Personal Access Token
245258

246-
See our [Personal Access Token documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) for setup instructions.
259+
For PAT authentication, see our [Personal Access Token documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) for setup instructions.
247260

248261
---
249262

@@ -252,26 +265,22 @@ See our [Personal Access Token documentation](https://docs.github.com/en/authent
252265
After setup:
253266
1. Restart your IDE completely
254267
2. Open Agent mode in Copilot Chat
255-
3. Click the tools icon to see available MCP tools
256-
4. Try: *"List recent issues in this repository"*
257-
5. Copilot can now access GitHub data and perform repository operations
268+
3. Try: *"List recent issues in this repository"*
269+
4. Copilot can now access GitHub data and perform repository operations
258270

259271
---
260272

261273
## Troubleshooting
262274

263275
- **Connection issues**: Verify GitHub PAT permissions and IDE version compatibility
264-
- **Authentication errors**:
265-
- Check if your organization has enabled the Editor Preview Policy
266-
- Ensure PAT has correct scopes
267-
- For Enterprise Managed Users with PAT restrictions, OAuth is not available
276+
- **Authentication errors**: Check if your organization has enabled the MCP policy for Copilot
268277
- **Tools not appearing**: Restart IDE after configuration changes and check error logs
269-
- **Local server issues**: Ensure Docker is running (for Docker-based setups) or Node.js is installed (for npx-based setups)
278+
- **Local server issues**: Ensure Docker is running for Docker-based setups
270279

271280
---
272281

273282
## What's Next
274283

275-
All IDEs now support the GitHub MCP server, with both remote and local installation options. While VS Code offers support for OAuth authentication, OAuth support is coming to all Copilot IDEs in the coming months.
284+
All IDEs now support the remote GitHub MCP server. VS Code offers OAuth authentication, while Visual Studio, JetBrains IDEs, Xcode, and Eclipse currently use PAT authentication with OAuth support coming soon.
276285

277286
**Advanced configuration:** See the [GitHub MCP Server repository](https://github.com/github/github-mcp-server) for toolsets, read-only mode, and additional options.

0 commit comments

Comments
 (0)