Skip to content

Commit 76644b9

Browse files
authored
Update installation guide for Windsurf with Docker changes...
...and deprecation notice for npm package. Clarified server setup.
1 parent 37fccd7 commit 76644b9

1 file changed

Lines changed: 7 additions & 22 deletions

File tree

docs/installation-guides/install-windsurf.md

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
## Remote Server Setup (Recommended)
99

10-
The remote GitHub MCP server is hosted by GitHub at `https://api.githubcopilot.com/mcp/` and supports both HTTP and SSE protocols. Windsurf currently supports PAT authentication only.
10+
The remote GitHub MCP server is hosted by GitHub at `https://api.githubcopilot.com/mcp/` and supports both HTTP and SSE protocols. Windsurf currently supports PAT authentication only for the remote GitHub server.
1111

1212
### Direct SSE Configuration
1313
Windsurf supports SSE servers with a `serverUrl` field:
@@ -27,7 +27,9 @@ Windsurf supports SSE servers with a `serverUrl` field:
2727

2828
## Local Server Setup
2929

30-
### Option 1: Docker (Recommended)
30+
### Docker Installation (Required)
31+
> **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.
32+
3133
```json
3234
{
3335
"mcpServers": {
@@ -49,23 +51,6 @@ Windsurf supports SSE servers with a `serverUrl` field:
4951
}
5052
```
5153

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

7156
### Via Plugin Store
@@ -129,7 +114,7 @@ After installation:
129114
### Local Server Issues
130115
- **Docker errors**: Ensure Docker Desktop is running
131116
- **Image pull failures**: Try `docker logout ghcr.io` then retry
132-
- **NPX failures**: Clear npm cache with `npm cache clean --force`
117+
- **Docker not found**: Install Docker Desktop and ensure it's running
133118

134119
### General Issues
135120
- **Invalid JSON**: Validate with [jsonlint.com](https://jsonlint.com)
@@ -140,6 +125,6 @@ After installation:
140125

141126
- **Official repository**: [github/github-mcp-server](https://github.com/github/github-mcp-server)
142127
- **Remote server URL**: `https://api.githubcopilot.com/mcp/`
143-
- **Docker image**: `ghcr.io/github/github-mcp-server`
144-
- **npm package**: `@modelcontextprotocol/server-github` (deprecated but functional)
128+
- **Docker image**: `ghcr.io/github/github-mcp-server` (official and supported)
129+
- **npm package**: `@modelcontextprotocol/server-github` (deprecated as of April 2025 - no longer functional)
145130
- **Windsurf limitations**: No environment variable interpolation, global config only

0 commit comments

Comments
 (0)