BrainLayer
Your AI has amnesia. BrainLayer fixes that.
Every architecture decision, every debugging session, every preference you've expressed — gone between sessions. You repeat yourself constantly. Your agents rediscover bugs they already fixed, and re-make choices the team already reasoned through.
BrainLayer gives any MCP-compatible AI agent persistent memory across conversations — and gives a whole fleet of agents a shared organizational memory: what one agent learns (a fix, a decision, what eroded and why) becomes experience the others inherit before they repeat the mistake. One SQLite file. No cloud. No Docker. Just pip install.
"What approach did I use for auth last month?" → brain_search
"Remember this decision for later" → brain_store
"What was I working on yesterday?" → brain_recall
"Ingest this meeting transcript" → brain_digest
"What do we know about this person?" → brain_get_person
Quick Start
pip install brainlayer
Add to your MCP config (~/.claude.json for Claude Code):
{
"mcpServers": {
"brainlayer": {
"command": "brainlayer-mcp-stdio-bridge"
}
}
}
That's it. Your agent now remembers everything. BrainBar must be running and
owning /tmp/brainbar.sock; brainlayer-mcp-stdio-bridge ships with the package,
reconnects if BrainBar restarts, and needs nothing on PATH beyond itself. If you
already have socat, {"command": "socat", "args": ["STDIO", "UNIX-CONNECT:/tmp/brainbar.sock"]}
works too — but it dies with the socket, and GUI hosts often lack /opt/homebrew/bin on PATH.
See docs/mcp-config.md.
Other editors (Cursor, Zed, VS Code)
Cursor (MCP settings):
{
"mcpServers": {
"brainlayer": {
"command": "brainlayer-mcp-stdio-bridge"
}
}
}
Zed (settings.json):
{
"context_servers": {
"brainlayer": {
"command": { "path": "brainlayer-mcp-stdio-bridge", "args": [] }
}
}
}
VS Code (.vscode/mcp.json):
{
"servers": {
"brainlayer": {
"command": "brainlayer-mcp-stdio-bridge"
}
}
}
MCP Tools (17)
The agent-facing MCP server is BrainBar on /tmp/brainbar.sock. It defines 17 tools, and
every definition carries ToolAnnotations
so agents know which calls are safe to run without confirmation.
Sessions boot into a core palette of 5. By default tools/list returns brain_search,
brain_store, brain_recall, brain_expand, and expand_palette — with short descriptions, to
keep the boot payload small. Call expand_palette (or set BRAINLAYER_MCP_PROFILE=full on the
server) to get all 17 with their full descriptions. Calling a gated tool before expanding returns
an error that tells you to expand.
| Tool | Type | Core | What it does |
|---|---|---|---|
brain_search |
read | ● | Semantic + keyword hybrid search across all memories. Lifecycle-aware, MMR-deduped. |
brain_store |
write | ● | Persist decisions, corrections, bug causes, learnings. Auto-importance scoring. |
brain_recall |
read | ● | Session-level context — current work, recent sessions, one session's detail, or stats. |
brain_expand |
read | ● | Open one search result in full, with the chunks around it. |
brain_entity |
read | Look up a person, project, company, or tool in the knowledge graph and its relations. | |
brain_get_person |
read | One person's profile, relations, and linked memories in a single call. | |
brain_tags |
read | List tags in use with counts; filter by substring. | |
brain_digest |
write | Digest a large raw block (transcript, doc, article) into a searchable chunk and connect its entities into the KG. | |
brain_update |
write | Change an existing chunk's importance or tags. Does not edit content. | |
brain_enrich |
write | Backfill summaries and enrichment metadata on existing chunks. | |
brain_subscribe |
write | Subscribe an agent to live notifications for given tags. | |
brain_unsubscribe |
write | Remove some or all of an agent's tag subscriptions. | |
brain_ack |
write | Acknowledge that an agent processed messages up to a chunk rowid. | |
brain_backup_vacuum_into |
write | Write a SQLite backup snapshot (VACUUM INTO) to a target path. |
|
brain_maintenance_rebuild_trigram |
write | Operator-triggered rebuild of the trigram FTS table in lock-aware batches. | |
brain_supersede |
destructive | Replace an old memory with a newer one and hide the old. Safety gate on personal data. | |
brain_archive |
destructive | Hide a chunk from default search, recoverably. |
brain_store outcomes
brain_store answers with an explicit outcome word, so an agent never has to guess whether a write
landed (#725):
STORED,DUPLICATE,MERGED,DEFERRED— all four are success. Do not re-store. (DEFERREDmeans the write is queued and will be persisted.)REJECTED,ERROR— nothing was stored. These return nostatusfield and nochunk_id;REJECTEDmeans the request itself cannot succeed as sent,ERRORis worth one retry.
Once a row is committed, the handler can no longer answer REJECTED or ERROR — a durable write
is never reported as "nothing was stored".
Tool descriptions on the wire
The rules for agents using BrainLayer live in the tool descriptions, so tools/list never drops a
description to fit a transport limit (#727). When
a response would exceed the frame budget, compaction runs as a ladder: first annotations and
inputSchema prose are dropped, and only if that still does not fit are descriptions shortened to
the largest budget that does — each marked …[truncated], with a
result._meta["brainlayer/descriptionsTruncated"] notice naming every affected tool. Descriptions
are never removed outright; if even the floor does not fit, the response ships over the limit with
its contract intact and logs why. The shipped palettes are covered by a test that fails if a newly
added tool ever pushes them into truncation.
Legacy brainlayer_* names (brainlayer_search, brainlayer_store, brainlayer_recall, and 11
more) are still accepted by the Python library handlers under src/brainlayer/mcp/. They are not
served by BrainBar, which is the agent transport — new wiring should use the brain_* names.
Architecture
graph LR
A["Claude Code / Cursor / Zed"] -->|MCP| B["BrainLayer<br/>17 tools"]
B --> C["Hybrid Search<br/>vector + FTS5"]
C --> D["SQLite + sqlite-vec<br/>single .db file"]
B --> KG["Knowledge Graph<br/>entities + relations"]
KG --> D
E["JSONL conversations"] --> W["Real-time Watcher<br/>~1s latency"]
W --> D
I["BrainBar UI<br/>NSStatusItem + NSPopover"] -->|UDS /tmp/brainbar.sock| BB["BrainBarDaemon<br/>MCP + brain bus"]
BB -->|MCP socket protocol| B
Everything runs locally. Cloud enrichment (Gemini/Groq) and Axiom telemetry are optional.
| Layer | Implementation |
|---|---|
| Storage | SQLite + sqlite-vec, WAL mode, single .db file |
| Embeddings | bge-large-en-v1.5 (1024 dims, CPU/MPS) |
| Search | Vector similarity + FTS5, merged with Reciprocal Rank Fusion |
| Watcher | Real-time JSONL indexing (~1s), 4-layer content filters, offset-persistent |
| Enrichment | 15 metadata fields per chunk — Groq, Gemini, MLX, or Ollama |
| Knowledge Graph | Entities, relations, co-occurrence extraction, person lookup |
Why BrainLayer?
| BrainLayer | Mem0 | Zep/Graphiti | Letta | |
|---|---|---|---|---|
| MCP tools | 17 | 1 | 1 | 0 |
| Local-first | SQLite | Cloud-first | Cloud-only | Docker+PG |
| Zero infra | pip install |
API key | API key | Docker |
| Real-time indexing | ~1s | No | No | No |
| Knowledge lifecycle | Supersede/archive | Auto-dedup | No | No |
| Open source | Apache 2.0 | Apache 2.0 | Source-available | Apache 2.0 |
BrainBar — macOS Companion
Optional native Swift menu bar companion split into two launchd-managed processes:
flowchart LR
UI["BrainBar<br/>LSUIElement UI"] -->|"watch-brain-bus + commands<br/>/tmp/brainbar.sock"| D["BrainBarDaemon<br/>headless MCP server"]
D -->|"single writer queue + reads"| DB["SQLite WAL<br/>~/.local/share/brainlayer/brainlayer.db"]
D -->|"helper subprocess IPC"| H["Hybrid search helper"]
BrainBarDaemon owns the MCP server, /tmp/brainbar.sock, the single-writer path, the watch-brain-bus stream, and helper subprocess lifecycle. BrainBar owns only the NSStatusItem, transient NSPopover, SwiftUI surfaces, hotkey routing, and a reconnecting socket subscriber. Killing the UI does not stop the daemon socket.
bash brain-bar/build-app.sh # Build, sign, install LaunchAgent
The build script builds both BrainBar and BrainBarDaemon, embeds both binaries in BrainBar.app, then installs com.brainlayer.brainbar.plist and com.brainlayer.brainbar-daemon.plist with ProcessType=Interactive. It refuses non-canonical checkouts and dirty trees by default (#265) and stamps each bundle with GitCommit, GitDescribe, and BuildTimeUTC in Info.plist (#264) so a stale install is diagnosable in seconds.
Writer Arbitration
Background producers run with BRAINLAYER_ARBITRATED=1 and append writes to ~/.brainlayer/queue/; com.brainlayer.drain.plist drains that queue every 500ms as the single writer. Trigram FTS maintenance is explicit via brainlayer repair-fts and the weekly com.brainlayer.repair-fts.plist, not synchronous startup work. See docs/arbitration.md.
Recent Hardening (2026-04-15 → 2026-05-17)
Two-week stability sprint behind the next presentation. Every line below traces to a merged PR.
Search recall & dedup
- FTS recall hardened across Python, Swift BrainBar, and the watcher pipeline (#263).
- Lexical defense dictionary exports for fragile-token recovery (#262).
- MMR post-retrieval dedup on
brain_search(#242). - Legacy unique
content_hashindex dropped — was blocking re-enrichment writes (#245). - Swift
brain_storequeue fallback so BrainBar can persist when the daemon is mid-restart (#261).
BrainBar reliability & UX
- MenuBarExtra(.window) rewrite with live-state sparklines and full-width hero (#248).
- Dashboard UX overhaul (#246).
- MCP
initializehandshake preserved under backpressure (#247). - KG force-sim early-exit +
onAppeartimer reset — kills CPU pegging when the graph tab is idle (#249).
Phase B preventive infra (2026-05-01) — one canonical artifact per environment
/post-merge-deploy-checkskill + initialcanonical-deploy-registry.json(orchestrator#60) cross-checks GitHub merge metadata, the registry, and the deployed app'sInfo.plistso a merged PR cannot be declared shipped while the local bundle still points at the wrong build.- Canonical app paths corrected in the deploy registry schema (orchestrator#58).
- Build-stamp + canonical-build guards land together so future BrainBar bundles carry provenance and refuse silent worktree overwrites (#264, #265).
Test gates — pre-push gate is mandatory before any push to main
- Pre-push regression gate (#257) plus exit-0 fix on the success path (#260).
scripts/run_tests.shorchestrator unifies Python + Swift + isolation test runs (#256).- Stale-index regression fixture (#255) and Deepchecks regression harness (#259).
Security
- Every Swift
MCPRoutertool exposed via BrainBar shipsToolAnnotations(cyberMaster H1) (#253) — 11 tools at the time, 17 today.
Reliability sprint (2026-05-02) — PR #251, merged
- Restores the resizable dashboard panel via a floating
NSPanel(BrainBarDashboardPanelController) instead of MenuBarExtra(.window). - Adds trigram FTS5 (
chunks_fts_trigram) with a startup-safety guard: synchronous backfill is skipped when the desynced trigram table exceeds 10K chunks, so BrainBar never blocks the live ~360K-chunk database before/tmp/brainbar.sockopens. - KG atlas presentation (importance-based altitude filtering, region backdrops, deterministic seeding) and
AgentActivityMonitorfor live CLI presence on the dashboard. - Pub/sub plane on
/tmp/brainbar.sockis explicitly preserved (brain_subscribe,brain_unsubscribe,notifications/claude/channel) — agent MCP is BrainBar; Python keeps library handlers only.
Phase 5 ship wave (2026-05-17) — ingest hygiene + KG regression fix
- Diagnostic + PreCompact noise rejection at ingest (#289) —
recursive_mcp_output_reasonnow detects BrainLayer-MCP-unavailable diagnostics and PreCompact checkpoint payloads, rejecting them at the watcher / drain / store ingestion heads so tooling failures do not become durable memory. The hybrid reranker demotes (not removes) any chunk tagged with precompact/quarantine signals so explicitinclude_checkpointscallers still see them. Pre-push gate:1995 passed, 9 skipped, 75 deselected, 1 xfailed. A dry-run-firstscripts/quarantine_noise.pyis available for back-filling existing infra noise — live DB mutation requires explicit--apply. - Persist digest LLM entities (#290) — fixes a KG persistence regression where
brain_digestsilently skipped Gemini entity extraction becauseprocess_chunkpasseduse_llm=llm_caller is not Noneand the MCP/CLI path never setsllm_caller. Non-seed person entities were never materialized intokg_entities/kg_entity_chunks. The 2026-04-06 entity-recall recurrence root-caused to this code path. RED-first regression test (test_digest_content_persists_llm_people_entities_for_lookup) now guards the fix. - Enrichment LaunchAgent recovered —
com.brainlayer.enrichmentwas silently unloaded since 2026-05-15 11:50 IDT (no entity extraction running). Bootstrapped back on 2026-05-17 against the 56K-chunk backfill; throttled by Gemini 503s on flex tier but actively draining (verified vialaunchctl list | grep enrichmentreturning a live PID).
June 2026 search & KG hardening (#433–#445)
- Hook failures are now loud (#433) — BrainLayer hook DB failures raise clearly instead of silently swallowing errors.
- Drain hardening (#435) — drain is now resilient to DB open locks under writer contention.
- chunk_origin provenance (#436, corrected in #717) —
chunk_originis ingest provenance, not the enrichment model. Enrichment records the model inmetadata.enriched_by; a backfill pass covers existing unknowns from ingest signals only. - MMR diversity is now on by default (#439) —
brain_searchapplies Maximal Marginal Relevance post-retrieval dedup on every hybrid query. There is no opt-out parameter. - KG entity dedup tooling (#441–#443) — new path-detector and APSW-safe dedup suggestions for cleaning duplicate KG entities; slash-command reclassify collisions also resolved (#444).
- KG boost reconnected to entity FTS (#445) — entity-aware ranking is now wired end-to-end through the FTS path.
Data Sources
| Source | Indexer |
|---|---|
| Claude Code | brainlayer index [DIR] (JSONL, defaults to ~/.claude/projects/) |
| Claude Code (real-time) | brainlayer watch LaunchAgent (~1s, 4-layer filters) |
| Codex CLI | brainlayer ingest-codex |
| T3 threads | brainlayer ingest-t3 |
| YouTube | python scripts/index_youtube.py |
| Manual | brain_store / brain_digest MCP tools |
index takes a source directory as a positional argument — there is no --source flag.
Claude Desktop, WhatsApp, and Markdown have extractors in src/brainlayer/pipeline/
(extract_claude_desktop.py, extract_whatsapp.py, extract_markdown.py) but no CLI subcommand
wired to them yet.
Enrichment
Each chunk gets 15 structured metadata fields from a local or cloud LLM
(summary, key_facts, tags, importance, intent, primary_symbols, resolved_queries,
epistemic_level, version_scope, debt_impact, external_deps, entities, sentiment_label,
sentiment_score, sentiment_signals). A sample:
| Field | Example |
|---|---|
summary |
"Debugging Telegram bot message drops under load" |
tags |
"telegram, debugging, performance" |
importance |
8 (architectural decision) vs 2 (directory listing) |
intent |
debugging, designing, implementing, deciding |
primary_symbols |
"TelegramBot, handleMessage, grammy" |
epistemic_level |
hypothesis, substantiated, validated |
brainlayer enrich # Run enrichment on new chunks
BRAINLAYER_ENRICH_BACKEND=groq brainlayer enrich # Force Groq
CLI Reference
brainlayer setup # Create ~/.config/brainlayer/brainlayer.env
brainlayer setup --launchd # Create config and install launchd agents
brainlayer init # Interactive setup wizard
brainlayer index # Batch index conversations
brainlayer watch # Real-time watcher (persistent, ~1s)
brainlayer search "query" # Semantic + keyword search
brainlayer enrich # LLM enrichment on new chunks
brainlayer stats # Database statistics
brainlayer brain-export # Brain graph JSON for visualization
brainlayer export-obsidian # Export to Obsidian vault
brainlayer dashboard # Interactive TUI
Testing
pip install -e ".[dev]"
git config core.hooksPath .githooks # install repo pre-push hook once per clone
pytest tests/ # 4,386 Python tests
pytest tests/ -m "not integration" # Unit tests only (fast)
ruff check src/ && ruff format src/ # Lint + format
# BrainBar: 890 Swift tests (cd brain-bar && swift test)
Configuration (environment variables)
| Variable | Default | Description |
|---|---|---|
BRAINLAYER_DB |
~/.local/share/brainlayer/brainlayer.db |
Database file path |
BRAINLAYER_ENRICH_BACKEND |
auto-detect | Enrichment backend (groq, gemini, mlx, ollama) |
GROQ_API_KEY |
(unset) | Groq API key for cloud enrichment |
AXIOM_TOKEN |
(unset) | Axiom telemetry token (optional) |
BRAINLAYER_ENRICH_RATE |
5.0 |
Requests per second (5.0 = 300 RPM, AI Pro supports 500+) |
BRAINLAYER_SANITIZE_EXTRA_NAMES |
(empty) | Names to redact from indexed content |
See full configuration reference for all options.
Optional extras
pip install "brainlayer[brain]" # Brain graph visualization + FAISS
pip install "brainlayer[cloud]" # Gemini Batch API enrichment
pip install "brainlayer[youtube]" # YouTube transcript indexing
pip install "brainlayer[ast]" # AST-aware code chunking (tree-sitter)
pip install "brainlayer[kg]" # GliNER entity extraction (209M params)
pip install "brainlayer[telemetry]" # Axiom observability
pip install "brainlayer[dev]" # Development: pytest, ruff
Contributing
Contributions welcome! See CONTRIBUTING.md for dev setup, testing, and PR guidelines.
License
Apache 2.0 — see LICENSE.
Part of Golems
BrainLayer is part of the Golems MCP agent ecosystem:
- BrainLayer — Persistent memory (this repo)
- VoiceLayer — Voice I/O for AI agents
- cmuxLayer — Terminal orchestration for AI agents
Originally developed as "Zikaron" (Hebrew: memory). Extracted into a standalone project because every developer deserves persistent AI memory.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file brainlayer-1.5.13.tar.gz.
File metadata
- Download URL: brainlayer-1.5.13.tar.gz
- Upload date:
- Size: 775.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bf173f10191ee94dea93595985e4f9f93141de02d11deeeae60b1dac48b8f801
|
|
| MD5 |
cb23050bafa81825d7da9b6b986e15e0
|
|
| BLAKE2b-256 |
d1d95000df38713193607dae57d89c77209619ded6a125a64173042b61a6643f
|
Provenance
The following attestation bundles were made for brainlayer-1.5.13.tar.gz:
Publisher:
publish.yml on EtanHey/brainlayer
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
brainlayer-1.5.13.tar.gz -
Subject digest:
bf173f10191ee94dea93595985e4f9f93141de02d11deeeae60b1dac48b8f801 - Sigstore transparency entry: 2710870330
- Sigstore integration time:
-
Permalink:
EtanHey/brainlayer@3126ac1bf55d2530223d3a11ff7a66346d109ee0 -
Branch / Tag:
refs/tags/v1.5.13 - Owner: https://github.com/EtanHey
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@3126ac1bf55d2530223d3a11ff7a66346d109ee0 -
Trigger Event:
push
-
Statement type:
File details
Details for the file brainlayer-1.5.13-py3-none-any.whl.
File metadata
- Download URL: brainlayer-1.5.13-py3-none-any.whl
- Upload date:
- Size: 878.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bab05118daa66832068dfecdb21b7e1da0803bec2b2122adac15b5e12cd37638
|
|
| MD5 |
cc70a01892d25ca48ccac687aadd5bd4
|
|
| BLAKE2b-256 |
50ed01f810b435317ace7cca5e398614ec9f17b508d65fc5600db0ef9ae8bd35
|
Provenance
The following attestation bundles were made for brainlayer-1.5.13-py3-none-any.whl:
Publisher:
publish.yml on EtanHey/brainlayer
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
brainlayer-1.5.13-py3-none-any.whl -
Subject digest:
bab05118daa66832068dfecdb21b7e1da0803bec2b2122adac15b5e12cd37638 - Sigstore transparency entry: 2710870910
- Sigstore integration time:
-
Permalink:
EtanHey/brainlayer@3126ac1bf55d2530223d3a11ff7a66346d109ee0 -
Branch / Tag:
refs/tags/v1.5.13 - Owner: https://github.com/EtanHey
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@3126ac1bf55d2530223d3a11ff7a66346d109ee0 -
Trigger Event:
push
-
Statement type: