Skip to main content
ClawQL

Quickstart

You can be up and running in a few minutes with npx—no global install required. Run clawql-mcp; for OpenAPI single-spec loads, execute prefers in-process OpenAPI→GraphQL. Optional CLAWQL_GRAPHQL_SOURCES / CLAWQL_GRPC_SOURCES add native protocols to the same search index (spec configuration).

New here? Start with Agent setup

The published package is large on disk (~90+ MB) because it ships bundled specs under providers/. That is intentional for offline discovery.

npx -p clawql-mcp clawql onboard --interactive

Creates ~/.ClawQL, writes Cursor MCP config, and runs a smoke search. Provider secrets go in vault/providers.json — not in mcp.json.

1. Start the MCP server

Default stack (Cloudflare, GitHub, Slack, Linear, Notion, Onyx):

npx -p clawql-mcp clawql-mcp

For every bundled vendor plus Google top-50 and AWS top-50:

CLAWQL_PROVIDER=all-providers npx -p clawql-mcp clawql-mcp

New to MCP wiring? Run clawql onboard --interactive or use the Agent setup copy-paste prompt in Cursor or Claude.

2. Connect your client

Add an MCP server entry that runs clawql-mcp on stdio (see MCP clients). No separate GraphQL process or GRAPHQL_URL is required.

3. Use your own API spec

Local file

CLAWQL_SPEC_PATH=./openapi.yaml npx -p clawql-mcp clawql-mcp

Remote OpenAPI

CLAWQL_SPEC_URL=https://example.com/openapi.json npx -p clawql-mcp clawql-mcp

Google Discovery

CLAWQL_DISCOVERY_URL="https://compute.googleapis.com/\$discovery/rest?version=v1" npx -p clawql-mcp clawql-mcp

4. HTTP transport (optional)

For clawql-mcp-http, MCP is at /mcp and GraphQL at /graphql on the same PORT.

PORT=8080 npx -p clawql-mcp clawql-mcp-http

Default local endpoint: http://localhost:8080/mcp (health: /healthz).

Install options

npm / yarn / bun

npm install clawql-mcp
# yarn add clawql-mcp
# bun add clawql-mcp

One-line install

curl -fsSL https://clawql.com/install | bash

Requires Node.js 22+. The script runs npm install -g clawql-mcp when npm is available.

Binaries

CommandPurpose
clawqlOnboarding CLI — onboard, init, doctor, secrets, mcp-config, sources, harness wrappers
clawql-mcpMCP server on stdio (Cursor, Claude Desktop, etc.)
clawql-mcp-httpMCP over Streamable HTTP (PORT, /mcp, /healthz, /graphql)

Docker

Multi-stage image and stdio/compose notes: docker/README.md. For the full stack, see Deployment.

5. Local bundled docs via Helm (Docker Desktop)

If you deploy locally with Kubernetes + Helm:

make local-k8s-up

You can open the bundled dashboard at http://clawql.localhost, bundled docs UI at http://docs.localhost, and point MCP clients at http://clawql-mcp.localhost/mcp (Ingress — same hostname + /mcp pattern as production). The script installs Kyverno and only admits Cosign-signed ClawQL images from GHCR — see Security.

Next steps