Skip to content

Commit e896408

Browse files
committed
Add Claude Desktop remote MCP server setup instructions
- Added npx mcp-remote configuration as recommended method for Claude Desktop - No Docker required for remote setup - simpler and more reliable - Uses environment variable format for secure token storage - Moved Docker setup as alternative method with existing compatibility warning - Updated prerequisites to clarify Docker vs npm requirements - Enhanced troubleshooting section for remote server issues - Standardized GitHub API URL format across documentation This makes it significantly easier for Claude Desktop users to connect to the GitHub MCP server without needing Docker installation.
1 parent 35b0da2 commit e896408

File tree

1 file changed

+44
-13
lines changed

1 file changed

+44
-13
lines changed

docs/installation-guides/install-claude.md

Lines changed: 44 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -81,16 +81,42 @@ claude mcp get github
8181
### Prerequisites
8282
- Claude Desktop installed (latest version)
8383
- [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new)
84-
- [Docker](https://www.docker.com/) installed and running
85-
86-
> **Note**: Claude Desktop supports MCP servers that are both local (stdio) and remote ("connectors"). Remote servers can generally be added via Settings → Connectors → "Add custom connector". However, the GitHub remote MCP server requires OAuth authentication through a registered GitHub App (or OAuth App), which is not currently supported. Use the local Docker setup instead.
84+
- For local setup: [Docker](https://www.docker.com/) installed and running
85+
- For remote setup: npm (Node.js) installed
8786

8887
### Configuration File Location
8988
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
9089
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
9190
- **Linux**: `~/.config/Claude/claude_desktop_config.json`
9291

93-
### Local Server Setup (Docker)
92+
### Remote Server Setup (Recommended - No Docker Required)
93+
94+
This method uses the GitHub MCP remote server without requiring Docker:
95+
96+
Add this configuration to your `claude_desktop_config.json`:
97+
98+
```json
99+
{
100+
"mcpServers": {
101+
"github": {
102+
"command": "npx",
103+
"args": [
104+
"mcp-remote",
105+
"https://api.githubcopilot.com/mcp",
106+
"--header",
107+
"Authorization: Bearer ${GITHUB_PERSONAL_ACCESS_TOKEN}"
108+
],
109+
"env": {
110+
"GITHUB_PERSONAL_ACCESS_TOKEN": "YOUR_GITHUB_PAT"
111+
}
112+
}
113+
}
114+
}
115+
```
116+
117+
> **Note**: Replace `YOUR_GITHUB_PAT` with your actual GitHub Personal Access Token. Ensure your token has the necessary `repo` scope permissions.
118+
119+
### Local Server Setup (Docker - Alternative Method)
94120

95121
Add this codeblock to your `claude_desktop_config.json`:
96122

@@ -118,15 +144,15 @@ Add this codeblock to your `claude_desktop_config.json`:
118144
### Manual Setup Steps
119145
1. Open Claude Desktop
120146
2. Go to Settings → Developer → Edit Config
121-
3. Paste the code block above in your configuration file
122-
4. If you're navigating to the configuration file outside of the app:
147+
3. Choose one of the two methods above (Remote Server recommended, or Docker for local setup)
148+
4. Paste the corresponding configuration in your `claude_desktop_config.json` file
149+
5. If you're navigating to the configuration file outside of the app:
123150
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
124151
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
125-
5. Open the file in a text editor
126-
6. Paste one of the code blocks above, based on your chosen configuration (remote or local)
127-
7. Replace `YOUR_GITHUB_PAT` with your actual token or $GITHUB_PAT environment variable
128-
8. Save the file
129-
9. Restart Claude Desktop
152+
- **Linux**: `~/.config/Claude/claude_desktop_config.json`
153+
6. Replace `YOUR_GITHUB_PAT` with your actual GitHub Personal Access Token
154+
7. Save the file
155+
8. Restart Claude Desktop
130156

131157
---
132158

@@ -135,11 +161,16 @@ Add this codeblock to your `claude_desktop_config.json`:
135161
**Authentication Failed:**
136162
- Verify PAT has `repo` scope
137163
- Check token hasn't expired
164+
- Ensure the token is correctly placed in your configuration
165+
166+
**Remote Server (Claude Desktop with npx mcp-remote):**
167+
- Verify URL: `https://api.githubcopilot.com/mcp`
168+
- Ensure npm is installed and accessible
138169

139-
**Remote Server:**
170+
**Remote Server (Claude Code):**
140171
- Verify URL: `https://api.githubcopilot.com/mcp`
141172

142-
**Docker Issues (Local Only):**
173+
**Docker Issues (Local Setup Only):**
143174
- Ensure Docker Desktop is running
144175
- Try: `docker pull ghcr.io/github/github-mcp-server`
145176
- If pull fails: `docker logout ghcr.io` then retry

0 commit comments

Comments
 (0)