Home/Docs/CorrdexLive MCP
CorrdexLive MCP

Use hosted Corrdex context from any MCP-capable coding agent

CorrdexLive MCP is the hosted MCP server for Corrdex. Instead of indexing the repo locally inside the agent runtime, it calls your hosted Corrdex project and returns the same trimmed context pipeline used by Corrdex AI before final answer generation.

At a glance
Uses hosted Corrdex project data, not local repo indexing.
Returns prompt-trimmed context, not raw unbounded context blobs.
Works with API key auth and optional default org, project, and branch ids.
Best used for semantic code discovery before falling back to manual file reads.
01

What It Is

CorrdexLive MCP is a small stdio MCP server that lets coding agents fetch hosted Corrdex context through your Corrdex account. It is different from the OSS local Corrdex MCP: local Corrdex builds intelligence from the current checkout on your machine, while CorrdexLive MCP reads the hosted indexed project and returns prepared context for the agent.

  • Use it when your repo is already indexed in Corrdex and you want hosted semantic context.
  • It routes plain-English questions through Corrdex scope selection and context trimming.
  • It is designed for coding agents, so the agent can ask short repo-native questions first and only open files after Corrdex narrows the target area.
02

What You Need

  • A Corrdex account with access to the target organization and project.
  • A Corrdex API key created from CorrdexSite.
  • The organization id when you want to list projects without hardcoding one default project.
  • Optional default project and branch ids if you want the agent to stay on one project or branch by default.
03

Install

bash
npm install -g corrdexlivemcp

The published package exposes the corrdexlivemcp command and runs on Node 20+.

04

Configure

CorrdexLive MCP reads its config from environment variables.

bash
CORRDEX_API_KEY=your_api_key
CORRDEX_API_BASE_URL=https://api.corrdex.app
CORRDEX_DEFAULT_ORGANIZATION_ID=your_org_id
CORRDEX_DEFAULT_PROJECT_ID=your_project_id
CORRDEX_DEFAULT_BRANCH_ID=your_branch_id
CORRDEX_REQUEST_TIMEOUT_MS=30000
json
{
  "mcpServers": {
    "corrdexlive": {
      "command": "corrdexlivemcp",
      "env": {
        "CORRDEX_API_KEY": "your_api_key",
        "CORRDEX_DEFAULT_ORGANIZATION_ID": "your_org_id",
        "CORRDEX_DEFAULT_PROJECT_ID": "your_project_id",
        "CORRDEX_DEFAULT_BRANCH_ID": "your_branch_id"
      }
    }
  }
}
  • CORRDEX_API_BASE_URL is optional and falls back to https://api.corrdex.app.
  • Set default project and branch ids if you want the agent to avoid broad multi-project or multi-branch requests.
  • If no default branch is configured, the agent can still pass branch ids explicitly through the tool.
05

Available Tools

corrdexlive_usage_guide

Short built-in guidance for agents on how to ask CorrdexLive efficiently before they start using the main context tool.

corrdex_projects

List projects visible to the API key. Use this first when the agent does not already know the project id.

corrdex_branches

List branches for a project so the agent can stay branch-specific instead of widening too early.

corrdex_context

Send a compact coding question through Corrdex and receive prepared, prompt-trimmed context for the agent.

06

Recommended Agent Flow

  • Read corrdexlive_usage_guide first if the agent is new to CorrdexLive.
  • Resolve project id with corrdex_projects unless a default project is already configured.
  • Resolve branch ids with corrdex_branches when branch-specific context matters.
  • Call corrdex_context with a short concrete question such as 'Where is syncRepositoryConnection implemented?' or 'Which route lists provider repositories?'.
  • Only after Corrdex narrows the target area should the agent open files directly or use grep-style tools for exact line work.
Prompting tip

CorrdexLive works best with short repo-native prompts. Prefer exact file names, function names, controller or route wording, provider names, and domain terms. Avoid vague prompts like "tell me about the backend" as a first query.