Documentation

Quickstart

From zero to your first search_code call in under ten minutes. Uses Claude Desktop as the MCP host.

This walkthrough assumes you have a Prometheus beta API key (mail hello@prom.codes if you don't) and Claude Desktop installed. If you use Cursor or Augment Code instead, the config blocks differ — see the MCP integration section.

1. Index a workspace

The indexer worker walks a Git repository over HTTPS, parses it, and persists the symbols + embeddings into your tenant's isolated Postgres rows.

curl -X POST https://api.prom.codes/index \
  -H "Authorization: Bearer <your-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "workspaceId": "<your-workspace-id>",
    "source": {
      "type": "git",
      "url": "https://github.com/<owner>/<repo>",
      "ref": "main"
    }
  }'

A successful response looks like:

{
  "ok": true,
  "fileCount": 124,
  "symbolCount": 1812,
  "chunkCount": 1812,
  "embeddedCount": 1812,
  "embedMs": 4220,
  "provider": "voyage",
  "model": "voyage-code-3",
  "dim": 1024,
  "region": "us"
}

See POST /index for the full request schema and the re-index behaviour (file-level idempotency via content hash).

2. Wire Claude Desktop

Open Claude Desktop → Settings → Developer → Edit Config and add:

{
  "mcpServers": {
    "prometheus": {
      "command": "npx",
      "args": ["-y", "@prometheus/context-mcp@latest"],
      "env": {
        "PROMETHEUS_API_KEY": "<your-api-key>",
        "PROMETHEUS_WORKSPACE_ID": "<your-workspace-id>"
      }
    }
  }
}

Restart Claude Desktop. A small hammer icon appears in the chat input when the prometheus server registered successfully.

3. Ask a real question

Try one of these in a new Claude Desktop conversation:

  • “Find the function that validates incoming webhook payloads in this workspace.”
  • “Show me all callers of chargeCustomer.”
  • “What does RetryQueue import from ./types?”

Claude will pick the matching MCP tool (search_code, find_references, expand_context, …) and quote the result in the reply. Tool calls are visible under the hammer icon — handy for debugging when results look off.

4. What's next