You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-18Lines changed: 14 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -176,26 +176,23 @@ The default uses `localhost:3001`. If using a tunnel (cloudflared, ngrok), edit
176
176
177
177
> **Note:**`.vscode/mcp.json` is gitignored so your local config won't be overwritten.
178
178
179
-
### Run in GitHub Codespaces (Easiest)
179
+
### Run in GitHub Codespaces
180
180
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.
182
182
183
-
#### Enable VS Code Insiders for Codespaces
183
+
#### Option A: Connect from VS Code Insiders Desktop (Full UI)
184
184
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.
189
186
190
-
Alternatively, you can open an existing Codespace in VS Code Insiders desktop:
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**
195
192
196
-
#### Create Codespace
193
+
#### Option B: Use Codespaces Web Editor (Tools Only)
197
194
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:
199
196
200
197
[](https://codespaces.new/samueltauil/copilot-compass?quickstart=1)
201
198
@@ -211,11 +208,10 @@ When your Codespace starts:
211
208
1. ✅ Dependencies are installed and project is built
212
209
2. ✅ MCP server starts automatically in the background on port 3001
213
210
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`)
217
213
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)
0 commit comments