Skip to content

Commit 44966c3

Browse files
authored
Update installation guide for Windsurf with security notes...
...and deprecated npm package information.
1 parent d6b50cf commit 44966c3

1 file changed

Lines changed: 2 additions & 25 deletions

File tree

docs/installation-guides/install-windsurf.md

Lines changed: 2 additions & 25 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 for the remote GitHub server.
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.
1111

1212
### Direct SSE Configuration
1313
Windsurf supports SSE servers with a `serverUrl` field:
@@ -28,7 +28,7 @@ Windsurf supports SSE servers with a `serverUrl` field:
2828
## Local Server Setup
2929

3030
### 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.
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.
3232

3333
```json
3434
{
@@ -67,29 +67,6 @@ Windsurf supports SSE servers with a `serverUrl` field:
6767
4. Save the file
6868
5. Click **Refresh** (🔄) in the MCP toolbar
6969

70-
## Security Best Practices
71-
72-
### Critical Security Note
73-
⚠️ **Windsurf does NOT support environment variable interpolation**. You must hardcode your PAT in the configuration file. This makes security practices crucial.
74-
75-
### File Protection
76-
```bash
77-
# Secure the configuration file
78-
chmod 600 ~/.codeium/windsurf/mcp_config.json
79-
80-
# Verify permissions
81-
ls -la ~/.codeium/windsurf/mcp_config.json
82-
```
83-
84-
### Token Security
85-
- Create PATs with minimum required scopes:
86-
- `repo` - For repository operations
87-
- `read:packages` - For Docker image pull (local setup)
88-
- Additional scopes based on tools you need
89-
- Use separate PATs for different projects
90-
- Regularly rotate tokens
91-
- Never commit configuration files to version control
92-
9370
## Configuration Details
9471

9572
- **File path**: `~/.codeium/windsurf/mcp_config.json`

0 commit comments

Comments
 (0)