feat: auto-configure mcp.json and start server in Codespaces

Author: samueltauil

.devcontainer/devcontainer.json

@@ -10,26 +10,27 @@
   "portsAttributes": {
     "3001": {
       "label": "MCP Server",
-      "onAutoForward": "notify",
+      "onAutoForward": "openBrowserOnce",
       "visibility": "public"
     }
   },
 
   "postCreateCommand": "npm install && npm run build",
+  "postStartCommand": "bash .devcontainer/setup.sh",
 
   "customizations": {
     "vscode": {
       "extensions": [
         "dbaeumer.vscode-eslint",
         "esbenp.prettier-vscode",
-        "bradlc.vscode-tailwindcss",
         "GitHub.copilot",
         "GitHub.copilot-chat"
       ],
       "settings": {
         "editor.formatOnSave": true,
-        "editor.defaultFormatter": null,
-        "typescript.preferences.importModuleSpecifier": "relative"
+        "editor.defaultFormatter": "esbenp.prettier-vscode",
+        "typescript.preferences.importModuleSpecifier": "relative",
+        "terminal.integrated.defaultProfile.linux": "bash"
       }
     },
     "codespaces": {

.devcontainer/setup.sh

@@ -0,0 +1,60 @@
+#!/bin/bash
+# Setup script for GitHub Codespaces
+# Configures MCP client settings and starts the server
+
+set -e
+
+echo "🧭 Copilot Compass - Codespaces Setup"
+echo "======================================"
+
+# Build if not already built
+if [ ! -f "dist/server.js" ]; then
+    echo "📦 Building project..."
+    npm run build
+fi
+
+# Get the Codespaces URL
+if [ -n "$CODESPACE_NAME" ]; then
+    MCP_URL="https://${CODESPACE_NAME}-3001.app.github.dev/mcp"
+    echo "✅ Codespaces detected: $CODESPACE_NAME"
+else
+    MCP_URL="http://localhost:3001/mcp"
+    echo "⚠️  Not running in Codespaces, using localhost"
+fi
+
+# Configure VS Code MCP settings
+MCP_CONFIG_DIR="$HOME/.vscode-server/data/User"
+MCP_CONFIG_FILE="$MCP_CONFIG_DIR/mcp.json"
+
+mkdir -p "$MCP_CONFIG_DIR"
+
+cat > "$MCP_CONFIG_FILE" << EOF
+{
+  "mcpServers": {
+    "copilot-compass": {
+      "type": "http",
+      "url": "$MCP_URL"
+    }
+  }
+}
+EOF
+
+echo "✅ MCP config written to: $MCP_CONFIG_FILE"
+echo ""
+echo "📋 MCP Server URL: $MCP_URL"
+echo ""
+
+# Check for GITHUB_TOKEN
+if [ -z "$GITHUB_TOKEN" ]; then
+    echo "⚠️  GITHUB_TOKEN not set - will use demo data"
+    echo "   Set it in Codespaces secrets: https://github.com/settings/codespaces"
+else
+    echo "✅ GITHUB_TOKEN is configured"
+fi
+
+echo ""
+echo "🚀 Starting MCP server..."
+echo "======================================"
+
+# Start the server
+exec node dist/server.js

README.md

@@ -156,7 +156,7 @@ Add to your MCP client configuration (e.g., Claude Desktop, VS Code):
 
 ### Run in GitHub Codespaces (Easiest)
 
-The fastest way to get started — no local setup required! Codespaces provides automatic HTTPS URLs, eliminating the need for tunneling tools.
+The fastest way to get started — no local setup required! Codespaces provides automatic HTTPS URLs and **auto-configures** the MCP client settings for you.
 
 [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/samueltauil/copilot-compass?quickstart=1)
 
@@ -166,9 +166,19 @@ The fastest way to get started — no local setup required! Codespaces provides
 2. Click **Code** → **Codespaces** → **Create codespace on main**
 3. Wait for the container to build (~2 minutes)
 
-#### Configure GitHub Token
+#### What Happens Automatically
 
-Before starting the server, add your GitHub token as a Codespaces secret:
+When your Codespace starts:
+1. ✅ Dependencies are installed and project is built
+2. ✅ MCP server starts automatically on port 3001
+3. ✅ Port 3001 is made public with HTTPS
+4. ✅ VS Code's `mcp.json` is configured with your Codespace URL
+
+The MCP server URL will be: `https://{codespace-name}-3001.app.github.dev/mcp`
+
+#### Configure GitHub Token (Optional)
+
+For live Copilot metrics (instead of demo data), add your GitHub token as a Codespaces secret:
 
 1. Go to [github.com/settings/codespaces](https://github.com/settings/codespaces)
 2. Click **New secret**
@@ -181,37 +191,34 @@ Alternatively, create a `.env` file in the Codespace terminal:
 
 ```bash
 echo "GITHUB_TOKEN=your-token-here" > .env
+npm start  # Restart the server
 ```
 
-#### Start the Server
+#### Verify It's Working
 
-```bash
-npm start
-```
+1. Check the terminal — you should see:
+   ```
+   🧭 Copilot Compass - Codespaces Setup
+   ✅ Codespaces detected: your-codespace-name
+   ✅ MCP config written to: ~/.vscode-server/data/User/mcp.json
+   🚀 Starting MCP server...
+   ```
 
-#### Get Your Public URL
+2. Open the **Ports** tab and verify port 3001 is public
 
-1. Open the **Ports** tab in VS Code (bottom panel)
-2. Find port `3001` (labeled "MCP Server")
-3. Right-click → **Port Visibility** → **Public** (if not already)
-4. Copy the **Forwarded Address** (e.g., `https://username-codespace-abc123-3001.app.github.dev`)
+3. The MCP server is now ready! Use it from Copilot Chat or any MCP client.
 
-#### Connect Your MCP Client
+#### Manual Start (If Needed)
 
-Use the Codespaces URL in your MCP configuration:
+If the server stops or you need to restart:
 
-```json
-{
-  "mcpServers": {
-    "copilot-compass": {
-      "type": "http",
-      "url": "https://username-codespace-abc123-3001.app.github.dev/mcp"
-    }
-  }
-}
+```bash
+npm start
+# Or with auto-config:
+bash .devcontainer/setup.sh
 ```
 
-> **Tip**: The Codespaces URL persists as long as your Codespace is running. For long-term use, consider running the server as a background task or using a dedicated VM.
+> **Tip**: The Codespaces URL persists as long as your Codespace is running. For long-term use, consider keeping the Codespace alive or using a dedicated VM.
 
 ### Public Access via Tunnel (Local Development)