Enhance CI workflow and documentation for DXT package integration

aronweiler · aronweiler · commit 7f9aeda3ba20 · 2025-07-20T00:45:41.000-07:00
- Added Node.js setup for DXT CLI in the CI workflow
- Installed DXT CLI as a build dependency
- Created DXT manifest file during the build process
- Updated README with instructions for using the MCP server with VS Code and Claude Desktop
diff --git a/.github/workflows/publish-mcp-package.yml b/.github/workflows/publish-mcp-package.yml
@@ -29,19 +29,70 @@ jobs:
       with:
         python-version: '3.10'
     
+    - name: Set up Node.js for DXT CLI
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+    
     - name: Install build dependencies
       run: |
         python -m pip install --upgrade pip
         python -m pip install build
+        npm install -g @anthropic-ai/dxt
     
-    - name: Build package
+    - name: Build Python package
       run: python -m build
     
+    - name: Create DXT manifest
+      run: |
+        cat > manifest.json << 'EOF'
+        {
+          "dxt_version": "1.0.0",
+          "name": "github-projects-mcp",
+          "version": "${{ github.ref_name }}",
+          "author": "Red Duck Labs",
+          "description": "A Model Context Protocol server for GitHub Projects",
+          "server": {
+            "type": "python",
+            "module": "github_projects_mcp.server"
+          },
+          "dependencies": {
+            "pip": ["github-projects-mcp==${{ github.ref_name }}"]
+          },
+          "configuration": {
+            "GITHUB_TOKEN": {
+              "type": "secret",
+              "description": "GitHub Personal Access Token with project permissions",
+              "required": true
+            },
+            "API_MAX_RETRIES": {
+              "type": "string",
+              "description": "Maximum retries for rate-limited requests",
+              "default": "3"
+            },
+            "API_RETRY_DELAY": {
+              "type": "string", 
+              "description": "Delay in seconds between retries",
+              "default": "60"
+            }
+          }
+        }
+        EOF
+    
+    - name: Build DXT package
+      run: dxt pack
+    
     - name: Upload build artifacts
       uses: actions/upload-artifact@v4
       with:
         name: dist
         path: dist/
+    
+    - name: Upload DXT package
+      uses: actions/upload-artifact@v4
+      with:
+        name: dxt-package
+        path: "*.dxt"
 
   publish:
     needs: build
diff --git a/README.md b/README.md
@@ -347,6 +347,111 @@ claude mcp add github-projects ./venv/Scripts/python github_projects_mcp/server.
 - Test token with: `gh auth status` or `curl -H "Authorization: token YOUR_TOKEN" https://api.github.com/user`
 - For Windows: Unicode console issues may appear but don't affect functionality
 
+## Using with VS Code
+
+VS Code supports MCP servers through GitHub Copilot (requires VS Code 1.102+ with MCP support enabled):
+
+### Option 1: Using MCP Commands (Recommended)
+
+1. **Install the MCP server:**
+   ```bash
+   pip install github-projects-mcp
+   ```
+
+2. **Add server using VS Code command:**
+   - Open Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`)
+   - Run `MCP: Add Server`
+   - Choose workspace or global configuration
+   - Enter server details when prompted
+
+### Option 2: Manual Configuration
+
+1. **Install the server:**
+   ```bash
+   pip install github-projects-mcp
+   ```
+
+2. **Create MCP configuration file:**
+
+   **For workspace-specific:** `.vscode/mcp.json`
+   
+   **For user-wide:** Use Command Palette &rarr; `MCP: Open User Configuration`
+
+   ```json
+   {
+     "inputs": [
+       {
+         "type": "promptString",
+         "id": "github-token",
+         "description": "GitHub Personal Access Token",
+         "password": true
+       }
+     ],
+     "servers": {
+       "github-projects": {
+         "type": "stdio",
+         "command": "github-projects-mcp",
+         "env": {
+           "GITHUB_TOKEN": "${input:github-token}"
+         }
+       }
+     }
+   }
+   ```
+
+3. **Restart VS Code** and configure your GitHub token when prompted
+
+## Using with Claude Desktop
+
+### Option 1: Install via DXT Extension (Recommended)
+
+When available, download the `.dxt` file from the [releases page](https://github.com/redducklabs/github-projects-mcp/releases) and install:
+
+1. **Download the `.dxt` file** from the latest release
+2. **Open Claude Desktop**
+3. **Install extension** by dragging the `.dxt` file into Claude Desktop or using the extension installer
+4. **Configure your GitHub token** when prompted
+
+### Option 2: Manual Installation
+
+1. **Install the MCP server:**
+   ```bash
+   pip install github-projects-mcp
+   ```
+
+2. **Add to Claude Desktop configuration:**
+
+   **On macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
+   
+   **On Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
+
+   ```json
+   {
+     "mcpServers": {
+       "github-projects": {
+         "command": "github-projects-mcp",
+         "env": {
+           "GITHUB_TOKEN": "your_github_token_here"
+         }
+       }
+     }
+   }
+   ```
+
+3. **Restart Claude Desktop**
+
+### Getting Your GitHub Token
+
+For both VS Code and Claude Desktop setup:
+
+1. **Go to GitHub Settings** &rarr; Developer settings &rarr; Personal access tokens
+2. **Create a new token** with these scopes:
+   - `project` (for managing projects)
+   - `read:project` (for reading project data)
+3. **Copy the token** and use it in your configuration
+
+**For organization projects:** Use a Fine-grained Personal Access Token with organization access.
+
 ### Example Usage with MCP Client
 
 For developers integrating programmatically:
