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).

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

1. Start the MCP server

npx -p clawql-mcp clawql-mcp

For every bundled vendor at once:

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

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 (see Install).

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 (including MCP, website, and dashboard images) — see Security and the repo doc golden-image-pipeline.md.

Next steps