Operate
Documentation
Organised by what
Organised by what
you are doing
Each part of the site is the documentation for one job, and the deep reference lives with the code it describes.
The reference in the repository →
QuickstartDownload, verify, start, load a dataset and run a query. Six steps.First run
BuildThe MCP block, the six agent tools, field types, and the HTTP API for everything else.Integrate
Query syntaxEvery operator with the field types it applies to, result shaping, sorting and what is refused.Ask
Client CLIThe REPL, schema-aware completion, and ingest from files or URLs.Work with it
OperateTopologies, containers, security posture, keys and limits, and behaviour under load.Run it
DownloadsBinaries, deb and rpm, checksums, signatures and SBOMs.Get it
Deep reference
The rest lives
The rest lives
with the code
Configuration covers every part of the node, setting by setting, and the reference in docs/ runs to thousands of lines. It lives in the repository, versioned with the engine, so it always matches the release you run.
Read the docs on GitHub →
docs/CONFIGURATION.mdEvery setting: network, storage, search, cluster, security profiles, rate limits, audit, environment variables and multi-disk layout.Configure
docs/DEPLOYMENT.mdDocker, systemd units and the Windows service, jemalloc tuning, multi-node topologies and reclaiming disk with
cameodb compact.Deploy
docs/API_REFERENCE.mdRequest and response shapes for every route, with the capability each one needs.Call
docs/MCP.mdThe operator’s guide to MCP: enabling, securing, connecting clients and shaping an index for agents.Agents
crates/mcp/README.mdThe MCP server in full: tools, resources, transports and protocol revisions.Agents
Inside the engine
How it is built,
How it is built,
and why
The design from the actors to the shards, every decision with the options it beat, and everything you need to build the binary yourself.
Architecture, in the engineering notes →
docs/README.mdWhat each document covers, then a write and a search followed across a cluster, step by step.Start here
docs/ARCHITECTURE.mdThe actor hierarchy, the hybrid shard, replication and consistency, and where blocking work is confined.Design
docs/ADR.mdEach architecture decision with the alternatives turned down, from the hash ring to state reconciliation.Decisions
docs/BUILDING.mdBuilding from source for Linux, macOS and Windows, the MSI installer and Docker.Build
docs/DEVELOPMENT.mdA clean macOS or Linux machine to build, test, validate and benchmark.Develop