Skip to content

Commit 01a3160

Browse files
authored
Update installation guide for Cursor with Docker changes...
...and deprecation of npm package @modelcontextprotocol/server-github.
1 parent d10b051 commit 01a3160

1 file changed

Lines changed: 6 additions & 21 deletions

File tree

docs/installation-guides/install-cursor.md

Lines changed: 6 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ As of Cursor v0.48.0, Cursor supports SSE servers directly:
2929

3030
## Local Server Setup
3131

32-
### Option 1: Docker (Recommended)
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.
34+
3335
```json
3436
{
3537
"mcpServers": {
@@ -51,23 +53,6 @@ As of Cursor v0.48.0, Cursor supports SSE servers directly:
5153
}
5254
```
5355

54-
### Option 2: NPX
55-
```json
56-
{
57-
"mcpServers": {
58-
"github": {
59-
"command": "npx",
60-
"args": ["-y", "@modelcontextprotocol/server-github"],
61-
"env": {
62-
"GITHUB_PERSONAL_ACCESS_TOKEN": "YOUR_GITHUB_PAT"
63-
}
64-
}
65-
}
66-
}
67-
```
68-
69-
**Note**: The npm package has a deprecation notice but remains functional.
70-
7156
## Installation Steps
7257

7358
### Via Cursor Settings UI
@@ -140,7 +125,7 @@ After installation:
140125
### Local Server Issues
141126
- **Docker errors**: Ensure Docker Desktop is running
142127
- **Image pull failures**: Try `docker logout ghcr.io` then retry
143-
- **NPX failures**: Clear npm cache with `npm cache clean --force`
128+
- **Docker not found**: Install Docker Desktop and ensure it's running
144129

145130
### General Issues
146131
- **MCP not loading**: Restart Cursor completely after configuration
@@ -150,6 +135,6 @@ After installation:
150135

151136
## Important Notes
152137

153-
- **Docker image**: `ghcr.io/github/github-mcp-server`
154-
- **npm package**: `@modelcontextprotocol/server-github` (deprecated, but functional as of latest update)
138+
- **Docker image**: `ghcr.io/github/github-mcp-server` (official and supported)
139+
- **npm package**: `@modelcontextprotocol/server-github` (deprecated as of April 2025 - no longer functional)
155140
- **Cursor specifics**: Supports both project and global configurations, uses `mcpServers` key

0 commit comments

Comments
 (0)