Technical Reference

August 8, 2026 · View on GitHub

In-depth technical documentation. See also the docs index for the full documentation map.

ReferenceDescription
ArchitectureSystem design and internals
Architecture DiagramsWorkspace dependency graph and other architecture diagrams
VelesQL Cheat SheetOne-page quick reference: search, filter, graph MATCH, fusion, sparse, EXPLAIN
VelesQL ContractCanonical REST contract (/query, /match, error model)
VelesQL ConformanceCross-ecosystem conformance matrix
Ecosystem Sync ReportFeature parity matrix across all components
MCP Tool Referencevelesdb-memory: every MCP tool, one section each — parameters, returns, limits, error model
Performance SLOCI-enforced performance objectives and budget gates
REST APIHTTP API endpoints
SIMD PerformanceSIMD optimizations and benchmarks
Native HNSWVelesDB's custom native HNSW implementation
Error CodesReference of VelesDB error codes
Known LimitationsInternal technical limitations of VelesDB Core

Machine-readable contracts

FileDescription
promise-contract.jsonVerbatim-pinned claims (numbers/phrasings) checked against README.md and other docs by scripts/check-promise-contract.py. Not a doc to read — a gate contract; see the warning comment at the top of the root README.md.