Local-first, zero-cloud memory for AI agents. SQLite-backed. Sub-millisecond. Fully private.
| Document | Description |
|---|
| Getting Started | Installation, quickstart, storing your first memory |
| Architecture | BEAM tiers, SQLite backend, hybrid search, knowledge graph |
| API Reference | Python API: remember, recall, sleep, triples, stats |
| CLI Reference | Every command, including the ones --help omits |
| Integrations | Platform guides: Cursor, Claude Code, Codex, OpenWebUI, Windsurf, OpenClaw, Hermes |
| OpenWebUI Deep Integration | Auto-save every chat, memory browser dashboard, cross-session recall |
| Integration Template | ~100-line pattern for adding any new platform |
| Hermes Integration | Using Mnemosyne as a Hermes memory backend |
| LLM Installation Guide | Installation instructions for AI agents/LLMs |
| Configuration | Environment variables, data directory, vector compression |
| Mnemosyne Sync | Bidirectional sync, encryption, deployment, tutorial |
| Security & Privacy | Threat model, encryption internals, BYOK comparison |
| Benchmarking | Maintainer guide: per-tool A/B benchmark env vars, diagnostics, pure-recall mode, test sequence template |
| Benchmark Results Analysis | Output-file schemas + analysis recipes (per-ability scores, paired bootstrap CIs, voice attribution). AI-assistant-friendly reference |
| Changelog | Pointer to the root CHANGELOG.md, plus release-state notes |
Written from the code by scripts/generate-docs.py and verified in CI by
scripts/verify-docs.py. Do not hand-edit these two files; edit the code or the
generator instead.
| Document | Description |
|---|
| MCP Tool Schema | All declared tools with parameters, split by whether they are reachable over MCP or only through the Hermes plugin |
| Configuration Reference | Every config key with its environment variable, real default, and restart requirement, plus the environment-only variables |
| Document | Description |
|---|
| Memory Hygiene | Noise scoring, the audit and clean workflow, secret detection, and how to prevent noise being stored |
| Configuration Profiles | The eight built-in profiles, what distinguishes them, validation rules, and the vec_type restart trap |
| L3 Persona Tier | Durable behavioural facts promoted into a store; prompt injection reads an opt-in persona.md file. Includes an explicit list of what is not yet wired |
| SHMR | Self-harmonizing memory reasoning. Library only; nothing calls it yet |
| Document | Description |
|---|
| Sync Protocol Reference | Wire protocol, endpoints, CLI reference, deployment recipes |
| Comparison: Mnemosyne vs Hindsight | Architecture, retrieval, and integration comparison against Hindsight self-hosted |
| BEAM Benchmark Results | The v3.0.0 BEAM run, methodology, and judge caveats. Source for the README figures |
| Compression Plugin | AAAK compression, the plugin interface, and the legacy caveman fallback |
| Hermes LLM Integration | Routing consolidation and extraction through a host-provided LLM backend |
| Audit Workflow | How documentation audits are run, and the report format |
Forward-looking design documents. An RFC describes intended behaviour, not shipped behaviour, so check its Status line before treating it as a description of the code.