Skip to content

Commit 6dc5540

Browse files
authored
Update Cursor installation link (#940)
* use new link * update local install link
1 parent d03072f commit 6dc5540

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

docs/installation-guides/install-cursor.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
# Install GitHub MCP Server in Cursor
22

33
## Prerequisites
4+
45
1. Cursor IDE installed (latest version)
56
2. [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new) with appropriate scopes
67
3. For local installation: [Docker](https://www.docker.com/) installed and running
78

89
## Remote Server Setup (Recommended)
910

10-
[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=github&config=eyJ1cmwiOiJodHRwczovL2FwaS5naXRodWJjb3BpbG90LmNvbS9tY3AvIiwiaGVhZGVycyI6eyJBdXRob3JpemF0aW9uIjoiQmVhcmVyIFlPVVJfR0lUSFVCX1BBVCJ9LCJ0eXBlIjoiaHR0cCJ9)
11+
[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=github&config=eyJ1cmwiOiJodHRwczovL2FwaS5naXRodWJjb3BpbG90LmNvbS9tY3AvIiwiaGVhZGVycyI6eyJBdXRob3JpemF0aW9uIjoiQmVhcmVyIFlPVVJfR0lUSFVCX1BBVCJ9fQ%3D%3D)
1112

1213
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.
1314

1415
### Install steps
16+
1517
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
1618
2. In Tools & Integrations > MCP tools, click the pencil icon next to "github"
1719
3. Replace `YOUR_GITHUB_PAT` with your actual [GitHub Personal Access Token](https://github.com/settings/tokens)
@@ -35,11 +37,12 @@ Uses GitHub's hosted server at https://api.githubcopilot.com/mcp/. Requires Curs
3537

3638
## Local Server Setup
3739

38-
[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=github&config=eyJjb21tYW5kIjoiZG9ja2VyIiwiYXJncyI6WyJydW4iLCItaSIsIi0tcm0iLCItZSIsIkdJVEhVQl9QRVJTT05BTF9BQ0NFU1NfVE9LRU4iLCJnaGNyLmlvL2dpdGh1Yi9naXRodWItbWNwLXNlcnZlciJdLCJlbnYiOnsiR0lUSFVCX1BFUlNPTkFMX0FDQ0VTU19UT0tFTiI6IllPVVJfR0lUSFVCX1BHVCJ9fQ==)
40+
[![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en/install-mcp?name=github&config=eyJjb21tYW5kIjoiZG9ja2VyIHJ1biAtaSAtLXJtIC1lIEdJVEhVQl9QRVJTT05BTF9BQ0NFU1NfVE9LRU4gZ2hjci5pby9naXRodWIvZ2l0aHViLW1jcC1zZXJ2ZXIiLCJlbnYiOnsiR0lUSFVCX1BFUlNPTkFMX0FDQ0VTU19UT0tFTiI6IllPVVJfR0lUSFVCX1BBVCJ9fQ%3D%3D)
3941

4042
The local GitHub MCP server runs via Docker and requires Docker Desktop to be installed and running.
4143

4244
### Install steps
45+
4346
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
4447
2. In Tools & Integrations > MCP tools, click the pencil icon next to "github"
4548
3. Replace `YOUR_GITHUB_PAT` with your actual [GitHub Personal Access Token](https://github.com/settings/tokens)
@@ -77,6 +80,7 @@ The local GitHub MCP server runs via Docker and requires Docker Desktop to be in
7780
- **Project-specific**: `.cursor/mcp.json` in project root
7881

7982
## Verify Installation
83+
8084
1. Restart Cursor completely
8185
2. Check for green dot in Settings → Tools & Integrations → MCP Tools
8286
3. In chat/composer, check "Available Tools"
@@ -85,16 +89,19 @@ The local GitHub MCP server runs via Docker and requires Docker Desktop to be in
8589
## Troubleshooting
8690

8791
### Remote Server Issues
92+
8893
- **Streamable HTTP not working**: Ensure you're using Cursor v0.48.0 or later
8994
- **Authentication failures**: Verify PAT has correct scopes
9095
- **Connection errors**: Check firewall/proxy settings
9196

9297
### Local Server Issues
98+
9399
- **Docker errors**: Ensure Docker Desktop is running
94100
- **Image pull failures**: Try `docker logout ghcr.io` then retry
95101
- **Docker not found**: Install Docker Desktop and ensure it's running
96102

97103
### General Issues
104+
98105
- **MCP not loading**: Restart Cursor completely after configuration
99106
- **Invalid JSON**: Validate that json format is correct
100107
- **Tools not appearing**: Check server shows green dot in MCP settings

0 commit comments

Comments
 (0)