Skip to content

Commit 64d001e

Browse files
almaleksiaalmaleksia
committed
Cline & Roo code installation guides
1 parent ccb9b53 commit 64d001e

File tree

3 files changed

+118
-0
lines changed

3 files changed

+118
-0
lines changed

‎docs/installation-guides/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ This directory contains detailed installation instructions for the GitHub MCP Se
77
- **[GitHub Copilot in other IDEs](install-other-copilot-ides.md)** - Installation for JetBrains, Visual Studio, Eclipse, and Xcode with GitHub Copilot
88
- **[Antigravity](install-antigravity.md)** - Installation for Google Antigravity IDE
99
- **[Claude Applications](install-claude.md)** - Installation guide for Claude Web, Claude Desktop and Claude Code CLI
10+
- **[Cline](install-cline.md)** - Installation guide for Cline
1011
- **[Cursor](install-cursor.md)** - Installation guide for Cursor IDE
1112
- **[Google Gemini CLI](install-gemini-cli.md)** - Installation guide for Google Gemini CLI
1213
- **[OpenAI Codex](install-codex.md)** - Installation guide for OpenAI Codex
14+
- **[Roo Code](install-roo-code.md)** - Installation guide for Roo Code
1315
- **[Windsurf](install-windsurf.md)** - Installation guide for Windsurf IDE
1416

1517
## Support by Host Application
@@ -23,8 +25,10 @@ This directory contains detailed installation instructions for the GitHub MCP Se
2325
| Copilot in JetBrains | ✅ | ✅ Full (OAuth + PAT) | Local: Docker or Go build, GitHub PAT<br>Remote: JetBrains Copilot Extension v1.5.53+ | Easy |
2426
| Claude Code | ✅ | ✅ PAT + ❌ No OAuth| GitHub MCP Server binary or remote URL, GitHub PAT | Easy |
2527
| Claude Desktop | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Moderate |
28+
| Cline | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
2629
| Cursor | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
2730
| Google Gemini CLI | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
31+
| Roo Code | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
2832
| Windsurf | ✅ | ✅ PAT + ❌ No OAuth | Docker or Go build, GitHub PAT | Easy |
2933
| Copilot in Xcode | ✅ | ✅ Full (OAuth + PAT) | Local: Docker or Go build, GitHub PAT<br>Remote: Copilot for Xcode 0.41.0+ | Easy |
3034
| Copilot in Eclipse | ✅ | ✅ Full (OAuth + PAT) | Local: Docker or Go build, GitHub PAT<br>Remote: Eclipse Plug-in for Copilot 0.10.0+ | Easy |

‎docs/installation-guides/install-cline.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Install GitHub MCP Server in Cline
2+
3+
[Cline](https://github.com/cline/cline) is an AI coding assistant that runs in VS Code-compatible editors (VS Code, Cursor, Windsurf, etc.). For general setup information (prerequisites, Docker installation, security best practices), see the [Installation Guides README](./README.md).
4+
5+
## Remote Server
6+
7+
Cline stores MCP settings in `cline_mcp_settings.json`. To edit it, click the Cline icon in your editor's sidebar, open the menu in the top right corner of the Cline panel, and select **"MCP Servers"**. You can add a remote server through the **"Remote Servers"** tab, or click **"Configure MCP Servers"** to edit the JSON directly.
8+
9+
```json
10+
{
11+
"mcpServers": {
12+
"github": {
13+
"url": "https://api.githubcopilot.com/mcp/",
14+
"type": "streamableHttp",
15+
"disabled": false,
16+
"headers": {
17+
"Authorization": "Bearer <YOUR_GITHUB_PAT>"
18+
},
19+
"autoApprove": []
20+
}
21+
}
22+
}
23+
```
24+
25+
Replace `YOUR_GITHUB_PAT` with your [GitHub Personal Access Token](https://github.com/settings/tokens). To customize toolsets, add server-side headers like `X-MCP-Toolsets` or `X-MCP-Readonly` to the `headers` object — see [Server Configuration Guide](../server-configuration.md).
26+
27+
> **Important:** The transport type must be `"streamableHttp"` (camelCase, no hyphen). Using `"streamable-http"` or omitting the type will cause Cline to fall back to SSE, resulting in a `405` error.
28+
29+
## Local Server (Docker)
30+
31+
1. Click the Cline icon in your editor's sidebar (or open the command palette and search for "Cline"), then click the **MCP Servers** icon (server stack icon at the top of the Cline panel), and click **"Configure MCP Servers"** to open `cline_mcp_settings.json`.
32+
2. Add the configuration below, replacing `YOUR_GITHUB_PAT` with your [GitHub Personal Access Token](https://github.com/settings/tokens).
33+
34+
```json
35+
{
36+
"mcpServers": {
37+
"github": {
38+
"command": "docker",
39+
"args": [
40+
"run", "-i", "--rm",
41+
"-e", "GITHUB_PERSONAL_ACCESS_TOKEN",
42+
"ghcr.io/github/github-mcp-server"
43+
],
44+
"env": {
45+
"GITHUB_PERSONAL_ACCESS_TOKEN": "YOUR_GITHUB_PAT"
46+
}
47+
}
48+
}
49+
}
50+
```
51+
52+
## Troubleshooting
53+
54+
- **SSE error 405 with remote server**: Cline does not yet support Streamable HTTP transport — use the local Docker setup instead
55+
- **Authentication failures**: Verify your PAT has the required scopes
56+
- **Docker issues**: Ensure Docker Desktop is installed and running

‎docs/installation-guides/install-roo-code.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Install GitHub MCP Server in Roo Code
2+
3+
[Roo Code](https://github.com/RooCodeInc/Roo-Code) is an AI coding assistant that runs in VS Code-compatible editors (VS Code, Cursor, Windsurf, etc.). For general setup information (prerequisites, Docker installation, security best practices), see the [Installation Guides README](./README.md).
4+
5+
## Remote Server
6+
7+
### Step-by-step setup
8+
9+
1. Click the **Roo Code icon** in your editor's sidebar to open the Roo Code pane
10+
2. Click the **gear icon** (⚙️) in the top navigation of the Roo Code pane, then click on **"MCP Servers"** icon on the left.
11+
3. Scroll to the bottom and click **"Edit Global MCP"** (for all projects) or **"Edit Project MCP"** (for the current project only)
12+
4. Add the configuration below to the opened file (`mcp_settings.json` or `.roo/mcp.json`)
13+
5. Replace `YOUR_GITHUB_PAT` with your [GitHub Personal Access Token](https://github.com/settings/tokens)
14+
6. Save the file — the server should connect automatically
15+
16+
```json
17+
{
18+
"mcpServers": {
19+
"github": {
20+
"type": "streamable-http",
21+
"url": "https://api.githubcopilot.com/mcp/",
22+
"headers": {
23+
"Authorization": "Bearer YOUR_GITHUB_PAT"
24+
}
25+
}
26+
}
27+
}
28+
```
29+
30+
> **Important:** The `type` must be `"streamable-http"` (with hyphen). Using `"http"` or omitting the type will fail.
31+
32+
To customize toolsets, add server-side headers like `X-MCP-Toolsets` or `X-MCP-Readonly` to the `headers` object — see [Server Configuration Guide](../server-configuration.md).
33+
34+
## Local Server (Docker)
35+
36+
```json
37+
{
38+
"mcpServers": {
39+
"github": {
40+
"command": "docker",
41+
"args": [
42+
"run", "-i", "--rm",
43+
"-e", "GITHUB_PERSONAL_ACCESS_TOKEN",
44+
"ghcr.io/github/github-mcp-server"
45+
],
46+
"env": {
47+
"GITHUB_PERSONAL_ACCESS_TOKEN": "YOUR_GITHUB_PAT"
48+
}
49+
}
50+
}
51+
}
52+
```
53+
54+
## Troubleshooting
55+
56+
- **Connection failures**: Ensure `type` is `streamable-http`, not `http`
57+
- **Authentication failures**: Verify PAT is prefixed with `Bearer ` in the `Authorization` header
58+
- **Docker issues**: Ensure Docker Desktop is running

0 commit comments

Comments
 (0)