Skip to content

Commit c4d01dc

Browse files
committed
docs: fix Codespaces instructions - VS Code Insiders requires desktop connection
1 parent cf24aa9 commit c4d01dc

1 file changed

Lines changed: 14 additions & 18 deletions

File tree

README.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -176,26 +176,23 @@ The default uses `localhost:3001`. If using a tunnel (cloudflared, ngrok), edit
176176

177177
> **Note:** `.vscode/mcp.json` is gitignored so your local config won't be overwritten.
178178
179-
### Run in GitHub Codespaces (Easiest)
179+
### Run in GitHub Codespaces
180180

181-
> ⚠️ **Important:** MCP Apps SDK (interactive dashboard UI) requires **VS Code Insiders**. The standard Codespaces editor uses stable VS Code which doesn't support MCP Apps yet.
181+
> ⚠️ **Important:** MCP Apps SDK (interactive dashboard UI) requires **VS Code Insiders**. The Codespaces web editor uses stable VS Code. To use the full dashboard UI, you must connect from VS Code Insiders on your local machine.
182182
183-
#### Enable VS Code Insiders for Codespaces
183+
#### Option A: Connect from VS Code Insiders Desktop (Full UI)
184184

185-
1. Go to [github.com/settings/codespaces](https://github.com/settings/codespaces)
186-
2. Scroll to **Editor preference**
187-
3. Select **Visual Studio Code Insiders** (not the stable version)
188-
4. Now create your Codespace — it will open in VS Code Insiders
185+
This gives you the complete MCP Apps experience with the interactive dashboard.
189186

190-
Alternatively, you can open an existing Codespace in VS Code Insiders desktop:
191-
1. Install [VS Code Insiders](https://code.visualstudio.com/insiders/)
192-
2. Open your Codespace on github.com
193-
3. Click the hamburger menu (≡) → **Open in VS Code Desktop**
194-
4. Select "Visual Studio Code Insiders" when prompted
187+
1. Install [VS Code Insiders](https://code.visualstudio.com/insiders/) locally
188+
2. Install the [GitHub Codespaces extension](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces) in VS Code Insiders
189+
3. Create a Codespace at [github.com/samueltauil/copilot-compass](https://github.com/samueltauil/copilot-compass)
190+
4. In the Codespace web view, click the hamburger menu (≡) → **Open in VS Code Desktop**
191+
5. When prompted, choose **Visual Studio Code Insiders**
195192

196-
#### Create Codespace
193+
#### Option B: Use Codespaces Web Editor (Tools Only)
197194

198-
The fastest way to get started — no local setup required! Codespaces provides automatic HTTPS URLs and **auto-configures** the MCP client settings for you.
195+
If you just need the MCP **tools** (not the visual dashboard), the web editor works fine:
199196

200197
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/samueltauil/copilot-compass?quickstart=1)
201198

@@ -211,11 +208,10 @@ When your Codespace starts:
211208
1. ✅ Dependencies are installed and project is built
212209
2. ✅ MCP server starts automatically in the background on port 3001
213210
3. ✅ Port 3001 is made public with HTTPS
214-
4.`.vscode/mcp.json` is created from the example template
215-
5. ✅ MCP discovery is enabled in VS Code settings
216-
6. ✅ README opens in preview mode
211+
4. ✅ MCP config is created at `/home/codespace/.vscode-remote/data/Machine/mcp.json`
212+
5. ✅ MCP settings are enabled (`chat.mcp.enabled`, `chat.mcp.discovery.enabled`)
217213

218-
The MCP server URL will be: `https://{codespace-name}-3001.app.github.dev/mcp`
214+
The MCP server URL is: `http://localhost:3001/mcp` (via port forwarding)
219215

220216
#### Configure GitHub Token (Optional)
221217

0 commit comments

Comments
 (0)