Reference

Generated from source

These sections are generated directly from source so they never drift from the running code:

• MCP Tools — one page per MCP tool, generated from the server’s Zod input schemas. Regenerate with pnpm docs:generate.
• Configuration — every environment variable with its type, default, and profile requirement, extracted from @engram/config. Regenerate with pnpm docs:generate. The hand-written configuration guide adds per-profile .env examples, security notes, and tuning guidance.
• API — TypeDoc reference for each @engram/* package, generated at build time from the TypeScript sources.

Regenerate the committed reference pages any time the code changes:

pnpm docs:generate

CI runs the same command and fails if the committed output is stale, so the reference always matches main.

Operational reference

Hand-maintained reference pages migrated from the repository docs:

• Capacity & scaling — load-test scenarios, measured baselines, scaling guidance.
• Concurrent-writer policy — the optimistic-version CAS rules for the UI, agents, and imports.
• Observability — metric catalogue and health endpoints.
• Release gates — per-profile SLOs and the reliability/security/coverage gates enforced before a release.
• Security (OWASP checklist) and security reviews.