MCP clients

Model Context Protocol is how editors and assistants connect to ClawQL. ClawQL Core — search, execute, audit, cache — has no opt-out. Hosts register ingest_external_knowledge and memory_ingest / memory_recall by default (set CLAWQL_ENABLE_MEMORY=0 to hide vault memory tools). Optional tools include sandbox_exec (CLAWQL_ENABLE_SANDBOX=1), notify (CLAWQL_ENABLE_NOTIFY, Slack chat.postMessage; Slack notify) and knowledge_search_onyx (CLAWQL_ENABLE_ONYX, Onyx when onyx is in the merge; Onyx knowledge search). Cursor and Claude Desktop are common hosts.

What is MCP?

The MCP server runs as a subprocess (stdio) or over the network (HTTP). Your client configuration supplies environment variables such as spec paths or CLAWQL_PROVIDER. Single-spec execute uses in-process OpenAPI→GraphQL; no separate GraphQL service is required.

stdio (npm)

Use npx with -p clawql-mcp so the binary resolves from the package:

{
  "mcpServers": {
    "clawql": {
      "command": "npx",
      "args": ["-p", "clawql-mcp", "clawql-mcp"],
      "env": {
        "CLAWQL_SPEC_PATH": "/absolute/path/to/openapi.yaml"
      }
    }
  }
}

stdio (git checkout)

{
  "mcpServers": {
    "clawql": {
      "command": "node",
      "args": ["/absolute/path/to/ClawQL/dist/server.js"],
      "env": {
        "CLAWQL_SPEC_PATH": "/absolute/path/to/openapi.yaml"
      }
    }
  }
}

For development you can run tsx against src/server.ts instead; ensure the repo is built for production-style runs.

Streamable HTTP

For clawql-mcp-http, Docker, Kubernetes, or Cloud Run, configure your client with a url (not command). Copy .cursor/mcp.json.example to .cursor/mcp.json and set the base URL your deployment exposes. See Deployment. For managed Tailscale or Headscale MagicDNS, CLAWQL_MCP_URL, and ${env:…} in mcp.json, see Tailscale & Headscale. GraphQL debugging is available at /graphql on the same origin.

OpenClaw

To use the OpenClaw CLI (npm install -g openclaw) as an MCP host for ClawQL — openclaw mcp set, HTTP vs stdio, env — see OpenClaw + ClawQL and the canonical repo guide docs/openclaw/using-openclaw-with-clawql.md.