Enables AI agents to discover and execute API operations via a token-efficient search-and-execute workflow over OpenAPI, Google Discovery, GraphQL, and gRPC.
Also known as danielsmithdevelopment/ClawQL, clawql-mcp
- Stars
- 13
- Tools
- —
- Downloads, 30 days
- —
- Latest version
- —
- Last commit
- Nov 15, 2026
- License
- Apache-2.0
What is ClawQL MCP?
ClawQL enables AI agents to discover and execute API operations via a token-efficient search-and-execute workflow over OpenAPI, Google Discovery, GraphQL, and gRPC.
Summary generated from the project's README
About ClawQL MCP server
ClawQL acts as an agentic gateway designed to help AI agents discover and run API operations through a token-efficient search and execute workflow. It supports a variety of protocols including OpenAPI, Google Discovery, GraphQL, and gRPC. Developers can use it as an MCP server in stdio or HTTP modes, connecting it to clients like Cursor or Claude Desktop. The system is built to minimize context window usage by allowing agents to search for specific operations before attempting to execute them.
The platform offers different feature tiers that can be configured via environment variables. Core tools like search, execute, audit, and cache are always active. Users can opt into additional capabilities such as memory management, document ingestion, and sandboxed execution. For specific integrations like Linear, users can provide a LINEAR_API_KEY or point to a GraphQL endpoint. The server can be deployed locally via npm or through containerized environments using Docker and Kubernetes.
What you can do with it
- 1Efficient API DiscoveryAn AI agent can search for specific API operations to avoid loading massive specification files into its prompt context.
- 2Multi-Protocol API ExecutionA developer can instruct an agent to execute commands across different services using REST, GraphQL, or gRPC protocols.
- 3Knowledge ManagementYou can task an agent with ingesting external documents or managing long-term memory using an Obsidian vault.
Written from the project's README. Every use case is checked against a quote from it.
How to install ClawQL MCP
Formats verified 10 Nov 2026Add to CursorAdd to GooseInstall ClawQL MCP in Claude Code
$ claude mcp add clawql -- npx -y clawql-mcpInstall ClawQL MCP in Cursor
~/.cursor/mcp.json
{
"mcpServers": {
"clawql": {
"command": "npx",
"args": [
"-y",
"clawql-mcp"
]
}
}
}Install ClawQL MCP in VS Code
.vscode/mcp.json
{
"servers": {
"clawql": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"clawql-mcp"
]
}
}
}Install ClawQL MCP in VS Code CLI
$ code --add-mcp '{"name":"clawql","type":"stdio","command":"npx","args":["-y","clawql-mcp"]}'Install ClawQL MCP in Claude Desktop
claude_desktop_config.json
{
"mcpServers": {
"clawql": {
"command": "npx",
"args": [
"-y",
"clawql-mcp"
]
}
}
}Install ClawQL MCP in Codex
$ codex mcp add clawql -- npx -y clawql-mcpInstall ClawQL MCP in Codex config.toml
~/.codex/config.toml
[mcp_servers.clawql] command = "npx" args = ["-y", "clawql-mcp"]
Install ClawQL MCP in Gemini CLI
$ gemini mcp add -s user clawql npx -- -y clawql-mcpInstall ClawQL MCP in Gemini settings.json
~/.gemini/settings.json
{
"mcpServers": {
"clawql": {
"command": "npx",
"args": [
"-y",
"clawql-mcp"
]
}
}
}Configuration
CLAWQL_INSTANCE_SPECCLAWQL_PROVIDER
| Name | Description | |
|---|---|---|
| CLAWQL_INSTANCE_SPEC | — | |
| CLAWQL_PROVIDER | — |
Automated checks
Ran Nov 13, 2026Full report →Passed our automated checks. That is not a security audit: read the code and give the server the narrowest access it needs. How checks work
- Source repository linked and reachablePass
- Open source license (OSI)Pass
- Commit or release in the last yearPass
- Package name not close to a popular packagePass
- Remote endpoint uses HTTPSNot checked
- Destructive tools are labelledNot checked
- No hidden instructions to the modelPass
- No critical advisory in the package or its dependenciesNot checked
README
View on GitHubClawQL
ClawQL provides the Agentic Gateway as the Foundational Platform for Auditable Production AI.
The Agentic Gateway is an MCP + OpenAI-compatible control plane for API discovery and execution with a token-efficient search -> execute workflow over OpenAPI, Google Discovery, and optional native GraphQL and gRPC sources (see CLAWQL_GRAPHQL_URL / CLAWQL_GRAPHQL_SOURCES / CLAWQL_GRPC_SOURCES in .env.example and ADR 0002). GraphQL-only vendors (e.g. Linear) need no OpenAPI spec: use CLAWQL_PROVIDER=linear (bundled SDL under providers/linear/ + LINEAR_API_KEY), or point CLAWQL_GRAPHQL_URL at their HTTP endpoint and auth headers, or load search from CLAWQL_GRAPHQL_SCHEMA_PATH / CLAWQL_GRAPHQL_INTROSPECTION_PATH (or per-source schemaPath / introspectionPath) when upstream introspection is disabled — without CLAWQL_SPEC_* / CLAWQL_PROVIDER, the default bundled REST specs are not loaded.
Enterprise topology: Zero-Trust Agentic Fabric (Regional Hubs · Dedicated Virtual Gateways · Edge Gateways). GTM: inference-first playbook.
What You Get
Feature tiers (aligned with the architecture diagram — details in docs/readme/configuration.md):
- ClawQL Core (always on — no opt-out):
search,execute,audit,cache— same band in the diagram; ring-buffer semantics forauditand LRU semantics forcacheindocs/mcp/enterprise-mcp-tools.mdanddocs/mcp/cache-tool.md. - Default on — opt out:
memory_ingest/memory_recall, and the document stack (ingest_external_knowledge, plusknowledge_search_onyxwhenCLAWQL_ENABLE_ONYX=1). UseCLAWQL_ENABLE_MEMORY=0orCLAWQL_ENABLE_DOCUMENTS=0to hide; vault path still required for real disk I/O on memory / ingest. - Default off — opt in:
sandbox_exec(CLAWQL_ENABLE_SANDBOX=1),schedule,notify,knowledge_search_onyx(needsCLAWQL_ENABLE_ONYX=1and documents on),ouroboros_*— seedocs/mcp/mcp-tools.md. When enabled,CLAWQL_SANDBOX_BACKEND: omit = bridge;auto= Seatbelt → Docker → bridge. - Stdio and HTTP MCP server modes
- Bundled provider specs for offline lookup and multi-provider workflows
Primary package: clawql-mcp (7.0.0 — Agentic Gateway entry; default stack, vault-first onboarding, opt-in operator scaffold — RELEASE_NOTES_v7.0.0.md · announcement drafts: docs/announcements/announcement-drafts-v7.0.0.md)
Repo: https://github.com/danielsmithdevelopment/ClawQL
Container images on GHCR (Docker / Helm)
Prebuilt images live on GitHub Container Registry under ghcr.io/danielsmithdevelopment/ (clawql-mcp, clawql-website, clawql-dashboard, clawql-panguard-mcp-bridge). They are supposed to be public so anyone can docker pull without credentials and Kubernetes defaults (Kyverno) can verify signatures. If docker pull returns denied, the registry package is still private — see docker/README.md § GHCR visibility (checklist + make ghcr-packages-public for maintainers).
Quick Start
Install:
npm install clawql-mcp
Run with a slim server (no bundled OpenAPI catalog loaded). Opt into the curated pack when you want it:
npx -p clawql-mcp clawql init --interactive # vault-first onboarding
npx -p clawql-mcp clawql mcp-config # MCP JSON for Cursor
# Optional curated pack (CF + GitHub + Slack + Linear + Notion + Onyx):
CLAWQL_INSTANCE_SPEC='{"providers":{"pack":"default"}}' npx -p clawql-mcp clawql-mcp
# Or: CLAWQL_PROVIDER=default npx -p clawql-mcp clawql-mcp
npx -p clawql-mcp clawql-mcp
For every bundled vendor plus Google top-50 and AWS top-50:
CLAWQL_PROVIDER=all-providers npx clawql-mcp
Then configure your MCP client (Cursor/Claude Desktop) to connect — or paste the agent setup prompt into your agent.
Documentation Map
Top-level docs index: docs/README.md
Start here
- Zero-Trust Agentic Fabric:
docs/architecture/zero-trust-agentic-fabric.md—/architecture/agentic-fabric - Getting started:
docs/readme/getting-started.md - Set up with your agent:
docs/getting-started/agent-setup-prompt.md· init walkthrough spec:docs/getting-started/clawql-init-walkthrough-spec.md - Plugins hub:
docs/plugins/README.md—/plugins - Configuration and env precedence:
docs/readme/configuration.md - Deployment and client config:
docs/readme/deployment.md(Kubernetes list linksdocs/deployment/docker-desktop-istio-observability.mdfor Istio + Prometheus/Grafana/Tempo/Kiali/OTel on Docker Desktop) - Benchmarks and case studies:
docs/readme/benchmarks.md - Development notes:
docs/readme/development.md - Tool workflow skills:
docs/skills/README.md
Core references
- Modularization ground truth:
docs/design/modularization-implementation-status.md - Plugin model & registry:
docs/design/clawql-plugin-model.md,docs/reference/clawql-plugin-registry.md - MCP tools and examples:
docs/mcp/mcp-tools.md - Workflow recipes:
docs/recipes/README.md - Memory and vault workflows:
docs/memory/memory-obsidian.md - Cache tool:
docs/mcp/cache-tool.md - Enterprise MCP notes (
auditthreat model, future metrics/governance):docs/mcp/enterprise-mcp-tools.md - Slack notify tool:
docs/mcp/notify-tool.md - Onyx knowledge tool:
docs/mcp/onyx-knowledge-tool.md - Ouroboros package and integration:
docs/ouroboros/clawql-ouroboros.md
Deployments
- Docker:
docker/README.md - Cloud Run:
docs/deployment/deploy-cloud-run.md - Kubernetes:
docs/deployment/deploy-k8s.md - Helm chart (
clawql-mcp):docs/deployment/helm.md - IDP umbrella chart (
clawql-idp):docs/deployment/clawql-idp-helm.md— full-stack profile viavalues-idp-full.yaml - IDP observability bundle:
docs/observability/README.md(Grafana dashboard + trace/metrics guide) - OpenClaw + Slack IDP runbook:
docs/openclaw/slack-first-idp-runbook.md - Agent PR → Argo CD GitOps:
docs/gitops/agent-pr-argocd-pipeline.md - Tailscale / Headscale (beginner guide):
docs/deployment/tailscale-and-headscale-for-clawql.md(website/tailscale) - Headscale runbook + ACL starter:
docs/deployment/headscale-tailnet.md,docs/deployment/headscale-acls-clawql.hujson
IDP (intelligent document processing)
Eight bundled vendors (Nextcloud, Docling, Tika, Gotenberg, Stirling, Paperless, Onyx, Coneshare) compose via search / execute or optional MCP tools (run_idp_pipeline, classify_document, extract_document). Hub: docs/providers/idp-pipeline.md · matrix: docs/roadmap/idp-master-requirements-matrix.md · OpenClaw profile: docs/openclaw/openclaw-idp-skill-profile.md
Security and supply chain
- Security overview and shipped controls:
docs/security/README.md - Golden image pipeline (CI → scan → push → sign → Kyverno enforcement):
docs/security/golden-image-pipeline.md - Defense in depth reference:
docs/security/clawql-security-defense-in-depth.md - Engineering deliverables matrix (shipped/partial/planned):
docs/security/clawql-security-defense-deliverables.md - Docker SBOM/sign/scan operator notes:
docker/README.md - npm publish hardening (pack → scan → publish, provenance):
docs/security/npm-supply-chain.md - Deploy-time image signature enforcement (admission / Kyverno):
docs/security/image-signature-enforcement.md
Providers and specs
- Provider matrix and presets:
providers/README.md - Google Discovery helpers:
docs/providers/google-apis-lookup.md - AWS top-50 preset:
docs/providers/aws-apis-lookup.md,docs/providers/aws-onboarding.md
Architecture (Short Version)
- Agent calls
searchto discover relevant operations without loading entire specs into prompt context. - Agent calls
executewith operation details. - For OpenAPI/Discovery operations: in single-spec mode, ClawQL prefers an internal OpenAPI-to-GraphQL path (REST fallback on failure); in multi-spec mode,
executeuses REST per owning spec. - For native operations (when configured):
executecalls HTTP GraphQL or gRPC unary directly — samesearchindex, routed by operation metadata — see ADR 0002.
Notes
- Core (
search,execute,audit,cache) has no opt-out — noCLAWQL_ENABLE_*gate for those tools. - A writable
CLAWQL_OBSIDIAN_VAULT_PATHis required to read/write the vault formemory_*and bulkingest_external_knowledge. - For full environment variable details, see
.env.exampleanddocs/mcp/mcp-tools.md.
ClawQL MCP questions
How do I add ClawQL MCP to Claude Code?
Run claude mcp add clawql -- npx -y clawql-mcp in your terminal. Add --scope user to make it available in every project.
How do I add ClawQL MCP to Cursor?
Open ~/.cursor/mcp.json and add the server under mcpServers, using the Cursor config shown in the install section above.
How does ClawQL handle API discovery for agents?
Agents call a search tool to discover relevant operations, which prevents the need to load entire API definitions into the prompt context.
What protocols does ClawQL support for execution?
It supports OpenAPI, Google Discovery, native GraphQL, and gRPC sources.
Can I use ClawQL with GraphQL-only vendors like Linear?
Yes, you can use the bundled SDL for Linear by setting the provider to linear, or point to an HTTP endpoint with auth headers.
What are the core tools that cannot be disabled?
The core tools include search, execute, audit, and cache, which are always on and have no opt-out.