UNPKG

christmas-mcp-copilot-runner

Version:

A Model Copilot Provider (MCP) for safely executing whitelisted system commands across platforms with automatic VS Code setup

83 lines (64 loc) 1.77 kB
# VS Code MCP Server Setup Guide ## Automatic Setup (Recommended) After installing the package globally: ```bash npm install -g christmas-mcp-copilot-runner ``` The setup script will automatically configure VS Code with the correct settings. ## Manual VS Code UI Setup If you prefer to add the server through VS Code's "Add Server..." UI, use these exact settings: ### Correct Configuration: ```json { "name": "christmas-mcp-copilot-runner", "command": "node", "args": [ "/path/to/global/npm/modules/christmas-mcp-copilot-runner/src/index.js", "--mcp" ], "cwd": "/your/project/directory", "env": {}, "disabled": false, "alwaysAllow": true } ``` ### ❌ Avoid This (VS Code Default): ```json { "command": "npx", "args": [ "christmas-mcp-copilot-runner@1.3.0" ] } ``` ## Finding Your Global npm Path ### Windows: ``` C:\Users\[username]\AppData\Roaming\npm\node_modules\christmas-mcp-copilot-runner\src\index.js ``` ### macOS: ``` /usr/local/lib/node_modules/christmas-mcp-copilot-runner/src/index.js ``` ### Linux: ``` /usr/local/lib/node_modules/christmas-mcp-copilot-runner/src/index.js ``` ## Automatic Detection: ```bash # Run this command to find your npm global root: npm root -g # Then append: /christmas-mcp-copilot-runner/src/index.js ``` ## Why Not npx? While `npx christmas-mcp-copilot-runner@1.3.0` works, using `node` with the direct path: - ✅ Faster startup (no package resolution) - ✅ More reliable (no version conflicts) - ✅ Better performance (direct execution) - ✅ Proper working directory support with `cwd` ## Verification After setup, test with: ``` Ask GitHub Copilot: "Use christmas-mcp-copilot-runner to run echo 'Hello MCP!'" ``` The command should execute without approval prompts.