Skip to main content

The memory database for AI agents — graph memory, hybrid search, audit trail.

Project description

Engrava

The memory database for AI agents.

Graph memory, hybrid search, and a tamper-evident audit trail — one pip install, no server, no LLM.

CI PyPI Python License: MIT

Engrava is a standalone embedded 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.

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[mcp]                # MCP server (engrava-mcp) for Claude Desktop/Code, Cursor, …
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.

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. 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.

Embedding Search

Store embeddings alongside thoughts and perform brute-force cosine similarity search. Pluggable embedding providers:

Provider Extra Backend
SentenceTransformerProvider embeddings-local Local model via sentence-transformers
OpenAICompatibleProvider embeddings-openai Any OpenAI-compatible API
OllamaProvider embeddings-ollama Local Ollama server
HuggingFaceProvider embeddings-hf HuggingFace 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, and recency scoring.

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 via the hook system.

Extension System

Plug into the thought lifecycle via EngravaHooksProtocol:

from engrava import EngravaHooksProtocol, ThoughtRecord, ScoringContext

class MyHooks(EngravaHooksProtocol):
    async def on_store(self, thought: ThoughtRecord) -> ThoughtRecord:
        # Transform thoughts before persistence
        return thought

    async def score_function(
        self, thought: ThoughtRecord, context: ScoringContext
    ) -> float:
        # Custom relevance scoring
        return thought.confidence or 0.5

Dreaming / Memory Consolidation

Built-in DreamingExtension for periodic memory consolidation — scores thoughts via configurable signals, promotes high-value entries, and creates REFLECTION thoughts by clustering semantically related thoughts and computing centroid embeddings (no LLM required). Available since 0.3.0.

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

Tamper-Evident Audit Trail

Opt-in hash-chain journal that records every thought/edge mutation as a SHA-256-linked, before/after entry — off by default, one config flag to enable. Query history with store.journal.get_entries(...) and validate the chain with store.journal.verify_integrity().

→ 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 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

Expose a store to any MCP client — Claude Desktop, Claude Code, Cursor, Windsurf, VS Code — via the engrava[mcp] extra. A native stdio server (no HTTP shim) with read tools, optional write tools, attachable engrava:// resources, and guided prompts:

pip install "engrava[mcp]"
engrava-mcp        # spawned by your MCP client over stdio

→ See docs/guides/mcp.md for install, client configuration, the full tool/resource/prompt reference, and read-only mode.

CLI

engrava --db mydata.db info          # Database stats
engrava --db mydata.db query "FIND 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            # Garbage-collect archived thoughts
engrava --db mydata.db migrate       # Ensure schema is up-to-date
engrava --db mydata.db export -o portable.json

engrava info now renders the same metrics snapshot contract exposed by await store.metrics().

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

  • 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 — expose a store to MCP clients (Claude Desktop, Claude Code, Cursor, Windsurf, VS Code): 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)
  • 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

pip install -e ".[dev]"
ruff check src/ tests/            # Lint
ruff format --check src/ tests/   # Format check
mypy --strict src/                # Type check
pytest --cov                      # Test with coverage

License

MIT — see LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

engrava-0.4.0.tar.gz (395.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

engrava-0.4.0-py3-none-any.whl (299.0 kB view details)

Uploaded Python 3

File details

Details for the file engrava-0.4.0.tar.gz.

File metadata

  • Download URL: engrava-0.4.0.tar.gz
  • Upload date:
  • Size: 395.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for engrava-0.4.0.tar.gz
Algorithm Hash digest
SHA256 72bbcfb323e05d6103a610bc38d49659bd431f682249415841473a1452f2640f
MD5 32d3be678aee77b69787bcd952c1378c
BLAKE2b-256 3dbb46540178050b793431bf39078181631fabed5cd52edecf9039eda24155cf

See more details on using hashes here.

Provenance

The following attestation bundles were made for engrava-0.4.0.tar.gz:

Publisher: release.yml on sovantica/engrava

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file engrava-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: engrava-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 299.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for engrava-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 50269f247caa6eb352f0edef70aacb7c9977e43728b8edbbf4cbbf0e9c880775
MD5 7e51a1ea1221e46622d8b9c75b20d953
BLAKE2b-256 36b1c11d3d281144ac7b6b1e1f9a4bfadc1ac0e952e31652ec4606fbaa91734f

See more details on using hashes here.

Provenance

The following attestation bundles were made for engrava-0.4.0-py3-none-any.whl:

Publisher: release.yml on sovantica/engrava

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page