Skip to content

README.md

Latest commit

 

History

History
48 lines (43 loc) · 2.44 KB

README.md

File metadata and controls

48 lines (43 loc) · 2.44 KB
Raw

Escurel documentation

This is the v1 specification of the Escurel knowledge-base service. Read it in the order below.

Reading order

  1. contract/agent-interface.md — the agent ↔ KB contract: twelve MCP tools, the mandatory escurel meta-skill, and the behavioural promises both sides depend on. The spec under spec/ is the implementation of this contract. 1a. contract/agent-orchestration.md — proposal (post-v1): event-driven agent-harness orchestration. A standalone escurel-agent-runner triggers a harness (Claude Code, Codex, Google ADK) on each new inbox element to project events into instance documents, with cascading + loop controls, keeping the gateway automation-free.
  2. spec/README.md — architecture overview, locked design decisions, crate layout, configuration, the v1 cut-line.
  3. spec/protocol.md — wire protocols (MCP-over-HTTP, WebSocket), full tool schemas, admin endpoints.
  4. spec/storage.md — per-tenant filesystem layout, the single DuckDB store with vss + fts + CRDT op log, markdown as the source of truth, S3 driver, audit / rebuild.
  5. spec/platform.md — OIDC auth, tenancy resolution, admin & lifecycle API, quotas, observability.
  6. spec/roadmap.md — milestones, v1 cut-line, deferred items, dependency license audit.
  7. spec/dx.md — downstream-app integration contract. Read this if you are consuming escurel from another application and need to wire it (plus, optionally, triton) into your test harness.
  8. adr/0001-duckdb-only-storage.md — the single architectural decision the v1 storage shape rests on, plus the pre-deployment empirical gate that must pass before any production rollout.
  9. deploy/substrate.md — deployment binding for the DataZoo Hetzner substrate (Kamal + ghcr + GCP); the image is the repo-root Dockerfile and the Kamal deploy contract lives in the substrate repo.

What this is not

  • Not the Rust implementation. The implementation will land alongside the spec in this repo; today there is no code.
  • Not a tutorial. This is the spec a Rust implementer or a substrate operator works from, not an end-user manual.