Back to Claude Mem

claude-mem Architecture Overview

docs/architecture-overview.md

12.7.16.1 KB
Original Source

claude-mem Architecture Overview

System Layers

text
+-----------------------------------------------------------+
|  Claude Code (host)                                       |
|  +-- Hook System (5 events)                               |
|  +-- MCP Client (search tools)                            |
+-----------------------------------------------------------+
|  CLI Layer (Bun)                                          |
|  +-- bun-runner.js (Node->Bun bridge)                     |
|  +-- hook-command.ts (orchestrator)                        |
|  +-- handlers/ (context, session-init, observation,        |
|                 summarize, session-complete)               |
+-----------------------------------------------------------+
|  Worker Daemon (Express, per-user port 37700+(uid%100))   |
|  +-- SessionManager (session lifecycle)                   |
|  +-- SDKAgent (Claude Agent SDK)                          |
|  +-- SearchManager (search orchestration)                 |
|  +-- ProcessRegistry (subprocess management)              |
|  +-- ChromaSync (embedding synchronization)               |
+-----------------------------------------------------------+
|  Storage Layer                                            |
|  +-- SQLite (claude-mem.db) -- structured data            |
|  +-- ChromaDB (chroma.sqlite3) -- vector embeddings       |
|  +-- MCP Server (interface for Claude Code)               |
+-----------------------------------------------------------+

Hook Lifecycle

EventHandlerWhat it doesTimeout
Setupversion-check.jsSub-100ms version-marker check; prompts npx claude-mem repair on mismatch60s
SessionStartworker start + contextStart worker service and inject context60s
UserPromptSubmitsession-initRegister session + start SDK agent + semantic injection60s
PostToolUseobservationCapture tool usage -> enqueue in worker120s
SummarysummarizeRequest session summary from SDK agent120s
SessionEndsession-completeEnd session + drain pending messages30s

On first install, npx claude-mem install sets up Bun and uv globally, runs bun install in the plugin cache, and writes an .install-version marker — all behind a visible clack spinner. The Setup hook then runs version-check.js on every Claude Code startup; if the plugin was upgraded externally (e.g. claude plugin update), it writes a hint to stderr asking the user to run npx claude-mem repair. The hook always exits 0 (non-blocking).

Data Flow

text
User prompt -> session-init -> /api/sessions/init + /api/context/semantic
  |
Tool use -> observation -> /api/sessions/observations
  |                              |
  |                    PendingMessageStore.enqueue()
  |                              |
  |                    SDKAgent.startSession()
  |                              |
  |                    Claude Agent SDK -> ResponseProcessor
  |                              |
  |                    +-- storeObservations() -> SQLite
  |                    +-- chromaSync.sync() -> ChromaDB
  |                    +-- broadcastObservation() -> SSE/UI
  |
Stop -> summarize -> /api/sessions/summarize
     -> session-complete -> /api/sessions/complete + drain

Key Patterns

Pending Queue (PendingMessageStore)

text
enqueue()                    -> INSERT row with `pending` status
clearPendingForSession()     -> DELETE all pending rows for session
                                (called whenever the parser returns
                                a parseable response, regardless of
                                whether observations were extracted)

Parser is binary: { valid: true, observations, summary } or { valid: false }. Unparseable responses leave the queue untouched and the session iterator continues.

Generator restart loop (SessionRoutes)

text
Generator crash -> retry 1 (1s) -> retry 2 (2s) -> retry 3 (4s)
  -> consecutiveRestarts > 3 -> stop and let the iterator end

Counter resets to 0 when generator completes work naturally. Pending messages remain in the queue across restarts and are cleared by the parser path on the next valid response.

Graceful Degradation (hook-command.ts)

text
Transport errors (ECONNREFUSED, timeout, 5xx) -> exit 0 (never block Claude Code)
Client bugs (4xx, TypeError, ReferenceError)  -> exit 2 (blocking, needs fix)

The worker being unavailable NEVER blocks the user's Claude Code session.

Deduplication (observations)

text
SHA256(memory_session_id + title + narrative)[:16] -> content_hash (16 hex chars)
If hash exists within 30s window -> return existing ID (no insert)

Two Types of Session ID

  • contentSessionId — from Claude Code, invariant during the session
  • memorySessionId — from SDK Agent, changes on each worker restart

The conversion between them is handled by SessionStore and is critical for FK constraints.

Storage

SQLite (claude-mem.db)

TableKey fieldsPurpose
sdk_sessionscontent_session_id, memory_session_id, statusSession lifecycle
observationsmemory_session_id, type, title, narrative, content_hashTool usage observations
session_summariesmemory_session_id, request, learned, completedSession summaries
user_promptscontent_session_id, prompt_textUser prompt history
pending_messagessession_db_id, message_typePer-session pending queue
observation_feedbackobservation_id, signal_typeUsage tracking

ChromaDB (chroma.sqlite3)

Vector embeddings for semantic search. Each observation generates multiple documents:

text
obs_{id}_narrative  -> main text
obs_{id}_fact_0     -> first fact
obs_{id}_fact_1     -> second fact
...

Accessed via chroma-mcp (MCP process), communication over stdio.

Process Management

  • ProcessRegistry: Tracks all Claude SDK subprocesses, manages PID lifecycle
  • Orphan Reaper (5min): Kills processes with no active session
  • GracefulShutdown: 7-step shutdown (PID file, children, HTTP server, sessions, MCP, DB, force-kill)