<h2>1. Prerequisites</h2>Before installing CodeRide MCP, you'll need these components:<h3>a. Node.js</h3>Node.js is a runtime environment that comes with npm (Node Package Manager), which is used to install CodeRide MCP.<blockquote>Check if you already have Node.js: Open your terminal or command prompt and run:<pre class="relative language-bash"><code class="language-bash relative">node -v
</code></pre>If you see version 18.0.0 or higher, you can skip to step 2.</blockquote>Installing Node.js:<ol class="steps-list"><li>Visit <a href="http://nodejs.org" target="_blank" rel="noopener noreferrer nofollow" class="cursor-pointer box-border font-semibold border-b hover:border-b-[2px] transition-all duration-75 " style="text-decoration: none; color: inherit; border-color: var(--portal-accent-color);">nodejs.org</a></li><li>Download the LTS (Long Term Support) version</li><li>Run the installer and follow the setup wizard</li><li>Restart your terminal</li><li>Verify installation: <code class="inline-code-shadow bg-gray-100 border border-gray-200/60 dark:border-gray-800 font-medium dark:bg-gray-700/60 text-gray-700 dark:text-gray-200 font-mono text-md px-1 py-0.5 rounded-[0.2rem] [&amp;::before]:content-none [&amp;::after]:content-none">node -v</code> should show a version number</li></ol>Alternative installation methods:<ul class="accent-bullets"><li>Windows: <code class="inline-code-shadow bg-gray-100 border border-gray-200/60 dark:border-gray-800 font-medium dark:bg-gray-700/60 text-gray-700 dark:text-gray-200 font-mono text-md px-1 py-0.5 rounded-[0.2rem] [&amp;::before]:content-none [&amp;::after]:content-none">winget install OpenJS.NodeJS</code></li><li>Mac: <code class="inline-code-shadow bg-gray-100 border border-gray-200/60 dark:border-gray-800 font-medium dark:bg-gray-700/60 text-gray-700 dark:text-gray-200 font-mono text-md px-1 py-0.5 rounded-[0.2rem] [&amp;::before]:content-none [&amp;::after]:content-none">brew install node</code> (requires <a href="https://brew.sh/" target="_blank" rel="noopener noreferrer nofollow" class="cursor-pointer box-border font-semibold border-b hover:border-b-[2px] transition-all duration-75 " style="text-decoration: none; color: inherit; border-color: var(--portal-accent-color);">Homebrew</a>)</li><li>Linux: Follow distribution-specific instructions on <a href="http://nodejs.org" target="_blank" rel="noopener noreferrer nofollow" class="cursor-pointer box-border font-semibold border-b hover:border-b-[2px] transition-all duration-75 " style="text-decoration: none; color: inherit; border-color: var(--portal-accent-color);">nodejs.org</a></li></ul><h3> b. CodeRide Account and API Key</h3>You'll need a CodeRide account and API key. See our <a href="https://productlane.com/edit-docs/fade027e-3af4-4b1a-b3c1-4d29516559d8#7-5-create-api-key-for-a-workspace" target="_blank" rel="noopener noreferrer nofollow" class="cursor-pointer box-border font-semibold border-b hover:border-b-[2px] transition-all duration-75 " style="text-decoration: none; color: inherit; border-color: var(--portal-accent-color);">API Key Setup Guide</a> for detailed instructions.<h3> c. Compatible AI Assistant</h3>CodeRide works with these MCP-compatible AI assistants:<ul class="accent-bullets"><li>Claude Desktop</li><li>VS Code with Cline</li><li>Windsurf</li><li>Cursor</li><li>GitHub Copilot</li></ul><h2>2. Installation</h2><h3>a. Via Smithery (Recommended)</h3>Smithery provides a web interface that automatically generates installation instructions for your specific AI assistant:<ol class="steps-list"><li>Log into Smithery: Visit <a href="http://smithery.ai" target="_blank" rel="noopener noreferrer nofollow" class="cursor-pointer box-border font-semibold border-b hover:border-b-[2px] transition-all duration-75 " style="text-decoration: none; color: inherit; border-color: var(--portal-accent-color);">smithery.ai</a> and create an account or log in</li><li>Navigate to the <a href="https://smithery.ai/server/@PixdataOrg/coderide" target="_blank" rel="noopener noreferrer nofollow" class="cursor-pointer box-border font-semibold border-b hover:border-b-[2px] transition-all duration-75 " style="text-decoration: none; color: inherit; border-color: var(--portal-accent-color);">CodeRide page</a></li><li>Select your AI assistant: Choose your client from the list (Claude Desktop, Cursor, Windsurf, Cline, etc.)</li><li>Add your API key: Insert your CodeRide API key when prompted</li><li>Follow the generated instructions: Smithery will provide specific setup steps for your chosen AI assistant</li></ol><h3> b. Manual Configuration</h3>If Smithery installation doesn't work, you can configure manually:Claude Desktop: Edit <code class="inline-code-shadow bg-gray-100 border border-gray-200/60 dark:border-gray-800 font-medium dark:bg-gray-700/60 text-gray-700 dark:text-gray-200 font-mono text-md px-1 py-0.5 rounded-[0.2rem] [&amp;::before]:content-none [&amp;::after]:content-none">~/.claude/mcp.json</code> (create if it doesn't exist):<pre class="relative language-json"><code class="language-json relative">{"mcpServers":<text> </text>{<text>
 </text>"coderide":<text> </text>{<text>
 </text>"command":<text> </text>"npx",<text>
 </text>"args":<text> </text>["-y",<text> </text>"@coderide/mcp"],<text>
 </text>"env":<text> </text>{<text>
 </text>"CODERIDE_API_KEY":<text> </text>"your_api_key_here"<text>
 </text>}<text>
 </text>}}}</code></pre><blockquote>Other AI assistants: Similar configuration through their respective settings panels or configuration consoles.</blockquote><h2></h2><h2>3. Verification</h2>To confirm everything is working:<ol class="steps-list"><li>Check in Smithery: Verify the installation completed successfully in your Smithery dashboard</li><li>Test in your AI assistant:<ul class="accent-bullets"><li>Restart the application</li><li>Look for CodeRide in available tools or context providers</li><li>Try creating a task or accessing CodeRide features</li></ul></li></ol><h2 class="text-lg font-bold text-text-100 mt-1 -mb-1.5">4. Available CodeRide Tools</h2>Once successfully connected, your AI assistant will have access to these CodeRide tools:<blockquote><code class="inline-code-shadow bg-gray-100 border border-gray-200/60 dark:border-gray-800 font-medium dark:bg-gray-700/60 text-gray-700 dark:text-gray-200 font-mono text-md px-1 py-0.5 rounded-[0.2rem] [&amp;::before]:content-none [&amp;::after]:content-none">get_task</code> - Retrieve details about a specific task (e.g., "Get me details for task APP-101")<code class="inline-code-shadow bg-gray-100 border border-gray-200/60 dark:border-gray-800 font-medium dark:bg-gray-700/60 text-gray-700 dark:text-gray-200 font-mono text-md px-1 py-0.5 rounded-[0.2rem] [&amp;::before]:content-none [&amp;::after]:content-none">update_task</code> - Update task status or description (e.g., "Mark task BUG-42 as completed")<code class="inline-code-shadow bg-gray-100 border border-gray-200/60 dark:border-gray-800 font-medium dark:bg-gray-700/60 text-gray-700 dark:text-gray-200 font-mono text-md px-1 py-0.5 rounded-[0.2rem] [&amp;::before]:content-none [&amp;::after]:content-none">get_prompt</code> - Get AI-specific instructions for a task (e.g., "What should I work on for task ETF-7?")<code class="inline-code-shadow bg-gray-100 border border-gray-200/60 dark:border-gray-800 font-medium dark:bg-gray-700/60 text-gray-700 dark:text-gray-200 font-mono text-md px-1 py-0.5 rounded-[0.2rem] [&amp;::before]:content-none [&amp;::after]:content-none">get_project</code> - Get project overview and details (e.g., "Tell me about the Omega Initiative project")<code class="inline-code-shadow bg-gray-100 border border-gray-200/60 dark:border-gray-800 font-medium dark:bg-gray-700/60 text-gray-700 dark:text-gray-200 font-mono text-md px-1 py-0.5 rounded-[0.2rem] [&amp;::before]:content-none [&amp;::after]:content-none">update_project</code> - Update project knowledge or diagrams (e.g., "Update the architecture diagram")<code class="inline-code-shadow bg-gray-100 border border-gray-200/60 dark:border-gray-800 font-medium dark:bg-gray-700/60 text-gray-700 dark:text-gray-200 font-mono text-md px-1 py-0.5 rounded-[0.2rem] [&amp;::before]:content-none [&amp;::after]:content-none">start_project</code> - Get the first or next recommended task (e.g., "What's the first task for project MBC?")</blockquote>Try asking your AI assistant something like "What tasks are available in my project?" to test the connection.

Get Started

This guide will walk you through setting up CodeRide MCP to work with your AI coding assistant.

MCP Installation