Skip to main content

Reference

API surfaces, configuration, protocol contracts, and implementation specifications — organized for operators and contributors.

Sections

  • Core concepts — architecture, feature tiers, planning vs execution
  • Protocol v2.1 — uniform envelope, approvals, HATEOAS, two-phase commit
  • Tools & configuration — MCP tool surface and CLAWQL_* environment variables
  • Contributor specification — Effect-TS contracts, CRD fields, CI enforcement

Core concepts

Architecture, feature tiers, cache vs vault, Ouroboros overview.

Protocol reference (v2.1)

Uniform envelope, approval flows, HATEOAS, two-phase commit.

MCP tool reference

search, execute, audit, cache, memory, optional tools and env gates.

Configuration reference

CLAWQL_* env vars, spec loading, provider presets, precedence rules.

Contributor technical specification

Implementation contracts, Effect-TS patterns, CRD fields, CI rules.

Bundled API specs

Provider presets shipped in clawql-mcp and CLAWQL_PROVIDER values.

Optional tools hub

Cache, schedule, notify, Onyx, sandbox — consolidated learn walkthroughs.

GraphQL layer

Internal OpenAPI→GraphQL projection vs native GraphQL sources.

NATS JetStream

Optional event backbone for Ouroboros and agent coordination.

Benchmarks

Planning-context comparisons and reproducible workflow artifacts.