Generated banner for Engrava
Generated logo for Engrava

Engrava

Memory frameworkOfficial Sovantica project

Created by Sovantica

Published in sovantica/engrava. Publisher page

12 GitHub stars

What it is

The memory database for AI agents - graph memory, hybrid search, tamper-evident thought/edge journal.
— the description by Sovantica

AutoGineer overview, from the brain’s own files

Engrava is an in-process memory database designed for AI agents, built on SQLite. It provides a structured way to store and retrieve agent thoughts using a graph-based model, where thoughts are linked by typed edges. The system supports hybrid search, combining vector similarity, full-text search (FTS5), recency, and priority. It includes built-in mechanisms for memory consolidation (dreaming), memory hygiene (archiving and garbage collection), and a tamper-evident journal for tracking mutations. Engrava operates as a library with no external service dependencies in its core path, allowing agents to maintain persistent, queryable state locally.

How it works

Memory model: Hybrid

AutoGineer overview, from the brain’s own files

Engrava uses a SQLite database to store thoughts and their relationships. It organizes data into thoughts and typed edges, which can be queried using the MindQL language. The system supports hybrid search by combining vector embeddings, keyword search, and metadata signals. It manages memory through a lifecycle that includes archiving and garbage collection, and it can consolidate memories into reflections. The system is extensible via hooks and provides an MCP server for integration with various AI agent frameworks.

Folders
FolderRoleFiles
.githubagent-config16
docsdocs37
examplesexamples13
scriptsscripts24
srcsource-code89
teststests201
.githooksfolder1

The agent reads

Requirements

Runtimes: Python >=3.11

Databases: SQLite

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Google Antigravity, Kiro, OpenCode, Amp, Roo Code, Cline, JetBrains Junie, Devin (ex-Windsurf)

Set it up

  1. This brain runs code automatically: 2 scripts. Review .githooks/commit-msg, Makefile before opening the folder in Claude Code. No step below turns a hook on for you.

    • .githooks/commit-msg: runs on git commit-msg
    • Makefile: echo "$(BLUE)>> Installing engrava + dev dependencies$(RESET)"; $(PIP) install --upgrade pip setuptools wheel; $(PIP) install -e ".[dev]"; bash scripts/install_hooks.sh; echo "$(GREEN)>> Done. Run 'make check' to verify quality gate.$(RESET)"
  2. Not scanned by AutoGineerIts dependencies are installed by pip or uv when you run it and were not scanned by AutoGineer (5 declared). https://pypi.org/project/engrava/
  3. Created by Sovantica. Published in sovantica/engrava. Licence: MIT License.

Usage

AutoGineer overview, from the brain’s own files

  • Persistent memory for autonomous AI agents
  • Personal knowledge base management
  • Conversation storage with semantic retrieval
  • Research notes with associative linking
  • Memory-backed agent development
  • Audit-trailed thought and edge tracking
“Store a new observation about a project requirement.”
The agent uses the remember() method to persist the thought, which is then indexed for future hybrid search and graph traversal.
“Retrieve relevant context for a coding task.”
The agent uses the recall() method, which performs a hybrid search across FTS5, vector, and graph signals to return ranked, contextually relevant thoughts.
“Query the memory graph for all observations with high priority.”
The agent executes a MindQL query: FIND thoughts WHERE thought_type = 'OBSERVATION' AND priority = 'P1'.
“Consolidate old memories to free up space.”
The agent triggers the DreamingExtension to cluster related thoughts and compute reflections, or uses the memory hygiene loop to archive low-signal thoughts.

Documentation by Sovantica

Engrava

The memory database for AI agents.

A queryable memory graph with bi-temporal valid-time predicates — in an in-process Python library over one SQLite file, with no generative-model call in the core write path.

Image: CI Image: PyPI Image: Python Image: License: MIT

Engrava is a standalone, in-process database for AI agent memory. Built on SQLite, it provides thought CRUD, edge-based knowledge graphs, embedding-based similarity search, full-text search (FTS5/BM25), and a declarative extension system — all in a single package with zero external service dependencies.

Benchmark results are published, and the runs are reproducible from a separate repository. Every published run is Group A — memory_pipeline_llms: [], no language model anywhere in the memory layer's built-in path. That is a property of the architecture's default signals and hooks rather than a measurement, unless a custom Dreaming signal or Memory Hygiene hook is configured to call one.

  • Benchmark results — the live table: every published row with the comparability segment it belongs to.

  • engrava-benchmark — the runner. Clone it and reproduce a result against the package from PyPI. MIT.

  • Discussions — questions; reproduction questions belong in the Q&A category.

Use Cases

  • AI agent persistent memory

  • Personal knowledge base

  • Conversation storage with semantic search

  • Research notes with associative linking

  • Any application that needs a thought-graph with embeddings

Quick Start

Installation
pip install engrava

Optional extras:

pip install 'engrava[vec]'                # sqlite-vec vector search backend
pip install 'engrava[embeddings-local]'   # sentence-transformers embeddings (local model)
pip install 'engrava[embeddings-openai]'  # OpenAI-compatible embeddings API
pip install 'engrava[embeddings-ollama]'  # Ollama local embeddings server
pip install 'engrava[embeddings-hf]'      # HuggingFace Inference API embeddings

Dreaming/consolidation and the knowledge graph need no extra — they are part of the base install.

embeddings-local carries a large first-run download. It pulls sentence-transformers and torch, plus a further, separate model download (~88 MB for all-MiniLM-L6-v2, cached under ~/.cache/huggingface/hub) on first use. On Linux, the PyPI build of torch also pulls the NVIDIA CUDA libraries as dependencies: several gigabytes, most of it usable only with an NVIDIA GPU. Without one, install the CPU-only build first (see Configuration: No NVIDIA GPU for the exact command and numbers). engrava-mcp[local] is the exact same download, reached through the server package instead of this one. If you do not need semantic search in-process, pip install engrava alone (no extra, no download, no model) already gives you keyword search, the graph, and MindQL — see Configuration → Quick-start profiles for that and the Ollama-backed alternative that keeps the model out of this process entirely.

Basic Usage

Store a memory and search for it in two calls — no IDs to generate, no record to assemble:

import asyncio

import aiosqlite

from engrava import SqliteEngravaCore


async def main() -> None:
    # SqliteEngravaCore wraps an open aiosqlite connection.
    async with aiosqlite.connect(":memory:") as conn:
        conn.row_factory = aiosqlite.Row
        store = SqliteEngravaCore(conn)
        await store.ensure_schema()

        await store.remember("Python is great for AI agents")
        await store.remember("SQLite needs no server")

        result = await store.recall("what language is good for agents?")
        for thought_id, score in result.results:
            thought = await store.get_thought(thought_id)
            if thought is not None:
                print(f"{thought.essence}  (score: {score:.3f})")


asyncio.run(main())

remember() stores the text as a thought (generating its ID for you) and returns the stored ThoughtRecord; recall() runs the same hybrid search as search_hybrid() and returns the ranked results. This store has no SearchConfig of its own, and it still ranks with the same default weights — FTS 0.30, vector 0.55, recency 0.10, priority 0.05, graph 0.00 (opt-in) — as a store built with one; see Hybrid Search. For full control — setting priority, thought type, metadata, or the cognitive cycle on a write — build a ThoughtRecord yourself and call create_thought().

From here, link thoughts with typed edges, query them with MindQL, or run the full ingest → dream → search tour in the Quick Start guide.

Configuration-Driven Setup
from engrava import SqliteEngravaCore

# from_config opens and OWNS the connection — use it as an async context manager.
async with await SqliteEngravaCore.from_config("engrava.yaml") as store:
    # The schema is already applied by from_config.
    thought = await store.get_thought("some-id")

See docs/configuration.md for the full YAML schema.

Upgrading

Automatic schema migration runs on first connection. See the upgrade guide for compatibility notes, backup guidance, and troubleshooting steps.

Features

Thought CRUD

Create, read, update, and archive thoughts with full lifecycle management. All models are frozen Pydantic objects — mutations happen via evolve().

Edge-Based Knowledge Graph

Link thoughts with typed, weighted edges. Edge types include ASSOCIATED, DEPENDS_ON, DERIVED_FROM, CONSOLIDATED_FROM (created by dreaming), and CONTESTED_BY.

Store embeddings alongside thoughts and search them with the built-in NumPy cosine backend or the optional sqlite-vec backend (pip install 'engrava[vec]'). Pluggable embedding providers:

ProviderExtraBackend
SentenceTransformerProviderembeddings-localLocal model via sentence-transformers
OpenAICompatibleProviderembeddings-openaiAny OpenAI-compatible API
OllamaProviderembeddings-ollamaLocal Ollama server
HuggingFaceProviderembeddings-hfHuggingFace Inference API
CallbackProvider(built-in)Custom callable
Full-Text Search (FTS5)

SQLite FTS5 virtual table with BM25 ranking. Hybrid search combines vector similarity, text relevance, recency, priority, and graph connectivity. Signals that cannot run for a query are skipped and the remaining weights are redistributed.

MindQL Query Language

Declarative query language for the thought-graph:

FIND thoughts WHERE thought_type = 'OBSERVATION' AND priority = 'P1' LIMIT 10
COUNT thoughts WHERE lifecycle_status = 'ACTIVE'
SELECT thought_id, essence FROM thought WHERE thought_type = 'BELIEF'

Extensible with custom commands through MindQLExecutor or an ExtensionManifest; the lifecycle hook registry is reserved and is not consulted by the core executor.

Extension System

Plug into the thought lifecycle via EngravaHooksProtocol. Subclass DefaultEngravaHooks when you only need selected active methods:

from engrava import DefaultEngravaHooks, ThoughtRecord

class MyHooks(DefaultEngravaHooks):
    async def on_store(self, thought: ThoughtRecord) -> ThoughtRecord:
        # Observe or enrich the object returned after persistence.
        return thought

    async def decay_function(
        self, thought: ThoughtRecord, elapsed_cycles: int
    ) -> float:
        # Supply a decay multiplier to an enabled Memory Hygiene pass.
        return 1.0

Core currently invokes on_store, on_retrieve, and decay_function. on_store runs after the source thought's row is inserted; changing its return value does not rewrite the persisted row. score_function and mindql_extension_registry() remain reserved protocol methods and are not called by core.

Dreaming / Memory Consolidation

Built-in DreamingExtension for periodic memory consolidation — scores thoughts via its default signals (no LLM calls), promotes high-value entries, and creates REFLECTION thoughts by clustering semantically related thoughts and computing centroid embeddings through a deterministic structural function, not an LLM. A custom signal you register with DreamingExtension runs whatever code it contains. Available since 0.3.0.

→ See docs/benchmarks.md for reproducible evidence (synthetic benchmark suite runnable in ~5 minutes).

Forgetting / Memory Hygiene

The subtractive half of memory maintenance, paired with Dreaming: an opt-in loop whose built-in scoring makes no LLM calls, that archives cold, low-signal thoughts — the default action, reversible via restore_thought — and, as a separately opted-in step, garbage-collects them (not reversible) once both restore windows have elapsed under their non-zero defaults — a cycle count and a wall-clock duration, either of which can be configured to 0 to disable that window. OFF by default; once enabled, archived thoughts drop out of default retrieval and can be restored (restore_thought / include_archived).

→ See docs/memory-hygiene.md for the loop, protection, restore windows, and the honest deletion posture.

Tamper-Evident Thought/Edge Journal

Opt-in hash-chain journal that records thought and edge mutations (plus action status/verification_status transitions) as SHA-256-linked, before/after entries — a tamper-evident thought/edge journal, not a whole-database audit (embeddings and action creation are not covered). Off by default, one config flag to enable. Query history with store.journal.get_entries(...) and validate the chain with store.verify_journal(), which audits whatever chain is on disk independent of the current journal.enabled state — the store.journal writer handle does not exist while journaling is off, but the chain earlier sessions wrote is still in journal_entry and still needs verifying.

→ See docs/audit-trail.md for enabling, querying, verification, and the security model (what "tamper-evident" does and does not guarantee).

Multi-Service Isolation

Run multiple independent databases under one EngravaManager:

from pathlib import Path

from engrava import EngravaManager

async with EngravaManager(data_dir=Path("./data")) as mgr:
    agent_a = await mgr.get_store("agent-a")
    agent_b = await mgr.get_store("agent-b")
    # Completely isolated databases
MCP Server

Want Engrava as a memory server for your agent? The MCP server ships as its own package, engrava-mcp — a native stdio server (no HTTP shim) with read tools, optional write tools, attachable engrava:// resources, and guided prompts, for any MCP client (Claude Desktop, Claude Code, Cursor, Windsurf, VS Code):

uvx engrava-mcp        # or: pip install engrava-mcp

engrava-mcp pulls engrava in transitively, so installing it also gives you the import engrava library. See the engrava-mcp package for install, client configuration, the full tool/resource/prompt reference, and read-only mode.

uvx vs. a persistent install. uvx engrava-mcp (equivalently uv tool run engrava-mcp) installs into "an ephemeral virtual environment in the uv cache directory" per uv's own --help text — fine for the lexical/network profiles above, which add nothing heavier than httpx. Once you are on the local profile (engrava-mcp[local], the same sentence-transformers + torch download as engrava[embeddings-local]), uv tool install 'engrava-mcp[local]' is the better fit: it installs once into a persistent environment — the same uvx engrava-mcp invocation then reuses that installed environment instead of resolving a fresh ephemeral one — and a later uv tool upgrade engrava-mcp re-pays only the changed packages, not the whole dependency tree.

CLI

engrava --db mydata.db info          # Database stats
engrava --db mydata.db query "FIND thoughts WHERE thought_type = 'OBSERVATION' LIMIT 5"
engrava --db mydata.db snapshot -o backup.jsonl
engrava --db mydata.db restore -i backup.jsonl
engrava --db mydata.db gc            # Collect ARCHIVED thoughts + their edges/embeddings/actions
engrava --db mydata.db migrate       # Ensure schema is up-to-date
engrava --db mydata.db export -o portable.json

gc physically deletes ARCHIVED thoughts together with every edge touching one on either end — including edges whose other end is still live — their embeddings and the actions sourced from them, then reconciles the vector index by removing every vec0 row no embedding row owns; on a vec0-indexed store where sqlite-vec cannot be loaded — most commonly because engrava[vec] is not installed — a pass that is about to delete stops before deleting anything and exits 1 rather than stranding those vectors in an index nothing can then reach them through.

engrava info's --format json output carries every field of the metrics snapshot exposed by await store.metrics(), with the snapshot's own schema version renamed metrics_schema_version, plus two fields the snapshot itself does not carry, db_path and database_schema_version — see Upgrade Guide. The default text output is a shorter summary of that same data, not the full snapshot.

See the CLI reference for every command and option.

Architecture

  • SQLite with WAL mode for concurrent reads

  • Frozen Pydantic models — immutable domain objects

  • Async-first — all I/O via aiosqlite

  • Hook-based extension — zero monkey-patching

  • Template method pattern — subclass SqliteEngravaCore for extended schemas

  • Zero external services — everything runs locally in-process

Documentation

  • Documentation Index — choose a path by task: learn, build, operate, extend, or migrate

  • Core Concepts — the mental model (thought, edge, reflection, cycle, …) — start here

  • The Bi-temporal Model — the optional valid-time axis: query a fact as of any instant, invalidate without deleting

  • Positioning — when Engrava is (and isn't) the right tool, and how it compares

  • Quick Start — 5-minute setup guide

  • Tutorial — build a small notes memory end to end

  • Recipes — copy-paste snippets for common tasks (store a turn, retrieve context, TTL, dedup, …)

  • Building a memory-backed agent — the end-to-end agent turn loop (ingest → retrieve → generate → consolidate)

  • Migrating from another memory system — concept mapping, porting calls, bulk import, and scoping/multi-tenancy

  • Embeddings — wiring a real embedding provider (local / OpenAI / Ollama / HuggingFace / custom)

  • MCP server (engrava-mcp) — expose a store to MCP clients (Claude Desktop, Claude Code, Cursor, Windsurf, VS Code) via the standalone server package: install, run, client config, tools/resources/prompts

  • Configuration — YAML config format and options

  • Upgrade Guide — compatibility matrix, backups, and troubleshooting

  • Extensions — Writing custom extensions and hooks

  • Observability — Metrics snapshot API

  • Audit Trail — Tamper-evident hash-chain journal (enabling, querying, verifying, security model)

  • Evidence and Conflicts — model claims, provenance, contested facts, and caller-owned clarification

  • Security — trust boundaries, data egress, tenant isolation, encryption posture, and journal limits

  • Error Handling and Recovery — decide when to retry, repair input, or replace a store

  • Benchmarks — release gates, versioned observed values, and LongMemEval

  • API Reference — Full protocol and class reference

  • CLI Reference — every engrava command and option

  • Glossary — quick definitions of every Engrava term

  • MindQL — Query language syntax and examples

  • Troubleshooting — symptom → cause → fix for common errors

  • FAQ — quick answers (LLM/keys, embeddings-optional, scale, concurrency, backups, …)

  • Performance & Scaling — the vector-backend switch, bulk-ingest, and dreaming cost at scale

  • Data Lifecycle & Retention — lifecycle states, TTL, archive-vs-delete, GDPR erasure, disk reclamation

  • Deployment — process model, database files on disk, containers, graceful shutdown

  • Concurrency — the WAL single-writer model, busy timeout, and per-service isolation

  • Backup & Recovery — WAL-safe backups, snapshot vs file copy, restore verification

  • Known Limitations — Platform notes and constraints

Development

make install   # deps + dev extras + local git hooks -- from the primary checkout
make gate      # fast: hooks-active + lint + format check + type check + goldens drift, ~70s
make check     # lint + format check + type check + the full test suite with coverage (unchanged; no hooks-active, no goldens drift)

make install also wires a commit-msg hook that lints the message of the commit a squash merge creates — including on a local branch that never opens a pull request, where nothing else does. It refuses to install from a linked worktree (core.hooksPath is shared across all of them). See CONTRIBUTING.md for what it covers and what it does not.

License

MIT — see LICENSE for details.

docs/troubleshooting.md

Troubleshooting

Common symptoms, their cause, and the fix. Each entry shows the error (or the surprising behaviour) you actually see, then what to change.

If your problem is a platform constraint rather than a mistake (macOS extension loading, the NumPy brute-force vector fallback, FTS5 availability), see Known Limitations instead.

AttributeError: 'tuple' object has no attribute 'keys' on read

Symptom. Writes succeed, but the first get_thought / search call raises:

AttributeError: 'tuple' object has no attribute 'keys'

Cause. The aiosqlite connection has no row factory, so rows come back as plain tuples. Engrava maps rows to records by column name and needs aiosqlite.Row. The failure surfaces on read, not on connect or write, which makes it look unrelated to setup.

Fix. Set the row factory immediately after connecting:

import aiosqlite

conn = await aiosqlite.connect("engrava.db")
conn.row_factory = aiosqlite.Row  # required

SqliteEngravaCore.from_config(...) opens the connection for you and sets this correctly — the manual snippet above only applies when you construct the store from your own connection.

ValueError: '...' is not a valid ThoughtType (or Priority, EdgeType, …)

Symptom.

ValueError: 'INSIGHT' is not a valid ThoughtType

Cause. A string was passed that is not a member of the enum. The valid ThoughtType members are TASK, OBSERVATION, BELIEF, REFLECTION, OUTPUT_DRAFT, and NOTE — there is no INSIGHT. The same applies to Priority (P1–P4), EdgeType, LifecycleStatus, etc.

Fix. Use a real enum member, ideally the symbol rather than a string literal:

from engrava import ThoughtType

ThoughtType.BELIEF  # preferred
ThoughtType("BELIEF")  # also valid — must match a real member

See Core Concepts for the full taxonomy and when to use each type.

Search returns nothing (or fewer results than expected)

Symptom. search_hybrid / search_fts returns an empty or short result list even though matching thoughts exist.

Cause. A signal you assumed was active was silently skipped, so the query ran on fewer signals than you expected. Engrava skips a signal rather than erroring when its prerequisite is missing. Work through this checklist:

If…then…
No embedding_provider is configured (and you pass no query_vector)the vector signal is skipped — only FTS/priority run. A purely semantic query with no shared keywords may find nothing. Passing your own query_vector re-enables the vector signal without a provider, for thoughts whose vectors you stored with store_embedding.
You pass query_text but no provider and no query_vectorsame as above — there is no vector to compare against.
No explicit current_cycle or recency_now, and no configured cycle_providerthe recency signal is skipped because no recency reference is available.
recency_weight is 0.0recency is disabled even when a cycle or transaction-time reference is available.
The query shares no FTS tokens with any thoughtFTS legitimately returns nothing — this is a real miss, not a bug. Note a bare query is OR-matched (any shared word hits), so this is rarer than it looks; if you instead get too many hits, you may want strict matching — see below.
You used lowercase and / or between wordsThese are not FTS5 operators — they are matched as ordinary words (and OR-joined like any bare query). Booleans must be uppercase (AND, OR, NOT).

Inspect which signals actually ran via HybridSearchResult.backends_used:

result = await store.search_hybrid("python async", top_k=5, current_cycle=10)
print(sorted(result.backends_used))  # e.g. ['fts5', 'priority', 'recency']

If 'vector' is missing and you expected semantic matching, configure an embedding provider (see the Embeddings guide). If 'recency' is missing, use a positive recency_weight and provide exactly one recency mode: pass current_cycle, configure a cycle_provider, or pass recency_now for transaction-time recency.

Keyword search returns too many results (I wanted all words to match)

Symptom. A multi-word search_fts query returns documents that contain only some of the words, not all of them.

Cause. A bare keyword query is matched with OR, by design — a document matches when it shares any word, and BM25 ranks the ones sharing the most distinctive words first (see Keyword query syntax). This is what lets natural-language questions find relevant answers; it is not a bug.

Fix. When you genuinely need every term, use FTS5 expert syntax explicitly — uppercase AND between the words, or a quoted phrase for an exact sequence:

# require both words
await store.search_fts("python AND asyncio", top_k=10)
# require an exact phrase
await store.search_fts('"event loop"', top_k=10)

Lowercase and/or will not work — they are matched as ordinary words.

Symptom. You expect a query containing http://…, 12:30, or a Windows path to error or to be interpreted as an FTS column filter.

Cause / behaviour. It does neither. Only the real essence: and content: column filters are honoured; any other token:token (a URL scheme, a clock time) is split into ordinary search terms, so the query is safe to run. When a normalized full-text expression is a genuinely malformed FTS5 query, engrava logs a warning, increments the read-only fts_match_failure_count counter, and retries once through the bare normalization (unsafe characters dropped, wildcards collapsed to legal prefixes, any exposed AND/OR/NOT phrase-quoted so FTS5 cannot read it as an operator), which is always a valid MATCH; the FTS arm returns that query's matches (an empty set when the sanitized query matches nothing). It does not raise. No action needed — this is the intended robustness — though a rising fts_match_failure_count is how you see it happening. See Keyword query syntax (FTS) and Observability signals.

Keyword search returns a thought after restore that does not contain the word

Symptom. After restore (a plain merge or --clear), search_fts / recall returns a thought whose essence and content plainly do not contain the word you searched for.

Cause. On 0.6.0, restore inserted records with INSERT OR REPLACE, so a record that collided with an existing row on a primary key or UNIQUE constraint made SQLite delete the old row and re-insert it internally to resolve the conflict — and because nothing in engrava sets PRAGMA recursive_triggers (SQLite's default is off), the FTS delete trigger never fires for a row removed this way, only the insert trigger for its replacement. The old, stale index entry survived, pointing at a rowid the thought table could later hand to a completely unrelated row (a later --clear restore, for instance) — at which point a keyword search for the original word resolved to that unrelated thought instead.

Fix. restore can still resolve a collision with INSERT OR REPLACE, but it now rebuilds the full-text index unconditionally, inside its own transaction, after every merge or --clear, so 0.7.0 cannot leave a stale entry behind this way.

Repair a database an older build already restored into. Rebuild its index directly with the SQLite CLI:

sqlite3 engrava.db "INSERT INTO thought_fts(thought_fts) VALUES('rebuild');"

This is FTS5's own index-rebuild command: it reconstructs thought_fts from the thought table's current rows, using the table's already-configured tokenizer. Verified directly against a database carrying stale entries built this way: afterward, a MATCH for each of that database's thoughts named only rows that actually contain the term, every column of every thought row came back unchanged (not just which ids survived), and the journal_entry row count was unchanged, and engrava verify afterward reported the journal valid with that same number of entries.

Dreaming promotes nothing (consolidation is inert)

Symptom. run_consolidation(...) returns promoted_count == 0 every time.

Cause. A candidate has to pass every stage below, and failing any one keeps the count at zero. Check them in this order:

  1. The age gate. A thought is eligible only when current_cycle - created_cycle >= min_age_cycles (default 1). If you never advance your cycle counter — every thought stays at the same current_cycle you created it in — 0 >= 1 is false and nothing is ever eligible. This is the most common cause. See Core Concepts → Cycle.

  2. The confirmation gate. Unless allow_zero_confirmation is True (the default), confirmation_count must be at least min_confirmations (default 2). With the flag turned off and no confirmations recorded, nothing passes.

  3. Eligibility filters. By default only OBSERVATION thoughts are promoted (promote_targets), and the metadata filters can reject a thought, for example the default excluded_content_types entry code. See Dreaming → Eligibility filters and corpus caps.

  4. The promotion threshold. Even after the stages above pass, a candidate's weighted signal score must be strictly greater than promote_threshold; a score exactly equal to it does not promote. Brand-new, unconfirmed, never-accessed thoughts score low, so a high threshold promotes nothing.

  5. The caps. A run promotes at most max_promoted_per_run thoughts (default 20), and it needs a free P1 slot. The number of free P1 slots for a run is max_p1_fraction of the store (default 0.05), rounded down but never below one thought, minus the thoughts that are already P1, so a small store has only a few slots and none once its P1 count has reached that number.

Fix.

from engrava.config import DreamingConfig, DreamingGates
from engrava.extensions.dreaming import DreamingExtension

config = DreamingConfig(
    enabled=True,
    promote_threshold=0.4,  # lower it if nothing clears the bar
    gates=DreamingGates(
        allow_zero_confirmation=True,  # essential for single-write ingest
        min_age_cycles=1,
    ),
)
ext = DreamingExtension(config=config)

# Advance current_cycle past the thoughts' created_cycle so the age gate passes:
result = await ext.run_consolidation(store, current_cycle=10)
print(result.promoted_count)

See Dreaming for the full gate-and-signal model.

Embedding ingest fails against an OpenAI-compatible endpoint

Symptom. Writes that auto-embed (or explicit embed calls) raise after a pause, either immediately or after a few seconds of retrying.

Cause / what to expect. OpenAICompatibleProvider retries a request with bounded linear backoff (base_retry_delay_s * attempt_number) on a transient failure — a read timeout or network blip, or a transient HTTP status (408, 409, 425, 429, 500, 502, 503, 504). Two outcomes:

  • A transient failure that persists across every attempt is raised as a RuntimeError once max_attempts is exhausted (it never loops forever). If you see this under sustained 429s, you are being rate-limited — raise base_retry_delay_s, lower your ingest concurrency, or batch more slowly.

  • A non-transient status (400, 401, 403, 404) is surfaced immediately with no retry — it indicates a request/auth/model error, not a blip. Check your api_key, base_url, and model_name.

Fix. Tune the retry budget on the provider (max_attempts, default 3; base_retry_delay_s, default 1.0), or address the underlying cause above. Only OpenAICompatibleProvider retries — OllamaProvider / HuggingFaceProvider do not. See the Embeddings guide.

EmbeddingModelMismatchError when opening an existing database

Symptom. A store that worked before now raises EmbeddingModelMismatchError on startup or first embed.

Cause. Engrava records the embedding model name and dimension in the database the first time it embeds. If you later open that same database with a different model name or a different dimension, the stored vectors are incompatible with new ones, so it refuses rather than silently mixing dimensions (which would corrupt similarity results).

The same error is raised when only the provider's document_prefix differs from the one the corpus was embedded with: adding one to a store built without, changing it, or removing it. A non-empty prefix is recorded as a fingerprint next to the model name; a store built without one records none. Adding, changing or removing a prefix is therefore a change to the corpus identity, and the vectors already stored were produced under the old one. A change to the query_prefix alone does not raise this error; it raises EmbeddingQueryPrefixMismatchError at search time instead. See Embeddings guide → Asymmetric prefixes.

Fix. Use the same embedding model and document_prefix the database was created with, or restore a trusted snapshot with a configured provider and deliberately re-embed the corpus. Direct mode uses top-level embeddings:

engrava --db restored.db --config engrava.yaml restore \
  -i backup.jsonl --clear --re-embed

Service mode prefers services.configs.<name>.embeddings and falls back to the top-level provider:

engrava --config engrava.yaml restore \
  --service main -i backup.jsonl --clear --re-embed

--re-embed requires --config with a provider at one of those levels. If no provider is configured, import with --skip-embeddings or keep the source embeddings unchanged. If the target already contains embeddings, restore also requires --clear; this prevents old vectors from surviving under the new model/dimension/prefix identity.

See Known Limitations → Embedding Dimension Consistency.

ReferentialIntegrityError when creating an edge

Symptom. Creating an edge to a thought that doesn't exist raises:

referential integrity violation: edge.to_thought_id='...' does not reference an existing thought

Cause. One endpoint of the edge (from_thought_id or to_thought_id) is not a real thought id. Create both thoughts before the edge that links them.

Fix.

from engrava import ReferentialIntegrityError

try:
    await store.create_edge(edge)
except ReferentialIntegrityError:
    ...  # one endpoint is missing — create the thought, then retry

Still stuck?

402 files · 357 not served here

Advantages

Limitations

Security

Risk level: Low risk

This brain runs

Git hooks (1)

  • .githooks/commit-msg (commit-msg): runs on git commit-msg

Agent instructions that run or fetch something (4)

  • AGENTS.md: Run `git commit` and it fires on the patterns it checks for.
  • CLAUDE.md: pip install -e ".[dev]"
  • CLAUDE.md: Run a clean test suite locally before pushing;
  • CLAUDE.md: Branch from `dev`, follow Conventional Commits, run the local quality gate before pushing.

Install scripts (1)

  • Makefile (make install): echo "$(BLUE)>> Installing engrava + dev dependencies$(RESET)"; $(PIP) install --upgrade pip setuptools wheel; $(PIP) install -e ".[dev]"; bash scripts/install_hooks.sh; echo "$(GREEN)>> Done. Run 'make check' to verify quality gate.$(RESET)"
  • Low risk: scripts-present (.githooks/commit-msg)
  • Low risk: network-instructions (CLAUDE.md:40)
  • Low risk: network-instructions (pyproject.toml:98)
  • Low risk: scripts-present (scripts/install_hooks.sh)

Attribution and licence

Created by
Sovantica
Declared authors
  • Sovantica (declared in pyproject.toml)
Publisher
Sovantica (Official Sovantica project)
Source
sovantica/engrava · commit f6a8b73
Licence
MIT License (files served here)
  • ATTRIBUTION.md (written by AutoGineer)
Synced

AutoGineer is not affiliated with or endorsed by Sovantica.

Install from source

357 of its files are not served here, so there is no ZIP. sovantica/engrava at f6a8b73