You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update installation guide for GitHub MCP Server (#699)
* Update installation guide for GitHub MCP Server
Removed reference to GitHub.com in the installation guide. The GitHub server is available to Coding Agent by default, without installation needed.
* Rename section to 'Install in Other MCP Hosts'
Updating title for consistency and adding a link to the "other Copilot IDEs" install guide.
* Revise installation guide for Cursor MCP setup
Updated installation guide for Cursor with steps clarified, remote server installation, and one-click install deeplinks to open Cursor and add the github server to the config file.
Copy file name to clipboardExpand all lines: README.md
+2-1Lines changed: 2 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -234,10 +234,11 @@ Optionally, you can add a similar example (i.e. without the mcp key) to a file c
234
234
235
235
</details>
236
236
237
-
### Install in Other Host Applications
237
+
### Install in Other MCP Hosts
238
238
239
239
For other MCP host applications, please refer to our installation guides:
240
240
241
+
-**[GitHub Copilot in other IDEs](/docs/installation-guides/install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
241
242
-**[Claude Code & Claude Desktop](docs/installation-guides/install-claude.md)** - Installation guide for Claude Code and Claude Desktop
242
243
-**[Cursor](docs/installation-guides/install-cursor.md)** - Installation guide for Cursor IDE
243
244
-**[Windsurf](docs/installation-guides/install-windsurf.md)** - Installation guide for Windsurf IDE
Copy file name to clipboardExpand all lines: docs/installation-guides/install-cursor.md
+33-49Lines changed: 33 additions & 49 deletions
Original file line number
Diff line number
Diff line change
@@ -7,10 +7,18 @@
7
7
8
8
## Remote Server Setup (Recommended)
9
9
10
-
The remote GitHub MCP server is hosted by GitHub at `https://api.githubcopilot.com/mcp/` and supports Streamable HTTP protocol. Cursor currently supports remote servers with PAT authentication.
Uses GitHub's hosted server at https://api.githubcopilot.com/mcp/. Requires Cursor v0.48.0+ for Streamable HTTP support. While Cursor supports OAuth for some MCP servers, the GitHub server currently requires a Personal Access Token.
13
+
14
+
### Install steps
15
+
1. Click the install button above and follow the flow, or go directly to your global MCP configuration file at `~/.cursor/mcp.json` and enter the code block below
16
+
2. In Tools & Integrations > MCP tools, click the pencil icon next to "github"
17
+
3. Replace `YOUR_GITHUB_PAT` with your actual [GitHub Personal Access Token](https://github.com/settings/tokens)
18
+
4. Save the file
19
+
5. Restart Cursor
11
20
12
21
### Streamable HTTP Configuration
13
-
As of Cursor v0.48.0, Cursor supports Streamable HTTP servers directly:
14
22
15
23
```json
16
24
{
@@ -25,12 +33,20 @@ As of Cursor v0.48.0, Cursor supports Streamable HTTP servers directly:
25
33
}
26
34
```
27
35
28
-
**Note**: You may need to update to the latest version, if the current version doesn't support direct Streamable HTTP
29
-
30
36
## Local Server Setup
31
37
32
-
### Docker Installation (Required)
33
-
> **Important**: The npm package `@modelcontextprotocol/server-github` is no longer supported as of April 2025. Use the official Docker image `ghcr.io/github/github-mcp-server` instead.
The local GitHub MCP server runs via Docker and requires Docker Desktop to be installed and running.
41
+
42
+
### Install steps
43
+
1. Click the install button above and follow the flow, or go directly to your global MCP configuration file at `~/.cursor/mcp.json` and enter the code block below
44
+
2. In Tools & Integrations > MCP tools, click the pencil icon next to "github"
45
+
3. Replace `YOUR_GITHUB_PAT` with your actual [GitHub Personal Access Token](https://github.com/settings/tokens)
46
+
4. Save the file
47
+
5. Restart Cursor
48
+
49
+
### Docker Configuration
34
50
35
51
```json
36
52
{
@@ -53,50 +69,18 @@ As of Cursor v0.48.0, Cursor supports Streamable HTTP servers directly:
53
69
}
54
70
```
55
71
56
-
## Installation Steps
57
-
58
-
### Via Cursor Settings UI
59
-
1. Open Cursor
60
-
2. Navigate to **Settings** → **Tools & Integrations** → **MCP**
61
-
3. Click **"+ Add new global MCP server"**
62
-
4. This opens `~/.cursor/mcp.json` in the editor
63
-
5. Add your chosen configuration from above
64
-
6. Save the file
65
-
7. Restart Cursor
66
-
67
-
### Manual Configuration
68
-
1. Create or edit the configuration file:
69
-
-**Global (all projects)**: `~/.cursor/mcp.json`
70
-
-**Project-specific**: `.cursor/mcp.json` in project root
71
-
2. Add your chosen configuration
72
-
3. Save the file
73
-
4. Restart Cursor completely
74
-
75
-
### Token Security
76
-
- Create PATs with minimum required scopes:
77
-
-`repo` - For repository operations
78
-
-`read:packages` - For Docker image pull (local setup)
79
-
- Additional scopes based on tools you need
80
-
- Use separate PATs for different projects
81
-
- Regularly rotate tokens
82
-
- Never commit configuration files to version control
83
-
84
-
## Configuration Details
85
-
86
-
-**File paths**:
87
-
- Global: `~/.cursor/mcp.json`
88
-
- Project: `.cursor/mcp.json`
89
-
-**Scope**: Both global and project-specific configurations supported
90
-
-**Format**: Must be valid JSON (use a linter to verify)
91
-
92
-
## Verification
93
-
94
-
After installation:
72
+
> **Important**: The npm package `@modelcontextprotocol/server-github` is no longer supported as of April 2025. Use the official Docker image `ghcr.io/github/github-mcp-server` instead.
73
+
74
+
## Configuration Files
75
+
76
+
-**Global (all projects)**: `~/.cursor/mcp.json`
77
+
-**Project-specific**: `.cursor/mcp.json` in project root
78
+
79
+
## Verify Installation
95
80
1. Restart Cursor completely
96
-
2. Open Settings → Tools & Integrations → MCP
97
-
3. Look for green dot next to your server name
98
-
4. In chat/composer, check "Available Tools"
99
-
5. Test with: "List my GitHub repositories"
81
+
2. Check for green dot in Settings → Tools & Integrations → MCP Tools
Copy file name to clipboardExpand all lines: docs/installation-guides/install-other-copilot-ides.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Install GitHub MCP Server in Copilot IDEs & GitHub.com
1
+
# Install GitHub MCP Server in Copilot IDEs
2
2
3
3
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)
0 commit comments