Skip to main content

A neuroscience-inspired memory engine for AI agents featuring private vaults, smart inbox review, and natural-language forgetting. Portable, federated, and zero-dependency.

Project description

Synapse AI Memory

A local-first memory engine for AI agents. Store facts, context, and conversation history in one place, then retrieve them as structured context with policy + privacy controls.

PyPI Python License

Current release: 0.13.0


Why this release

Recent work focuses on onboarding + runtime + integrations + policy receipts. The repo now provides a cleaner zero-prompt setup path, explicit runtime mode controls, and practical auditability for policy enforcement decisions.

Install

pip install synapse-ai-memory

Optional one-step installer still available:

curl -fsSL https://synapse.ai/install.sh | bash

Quick start (recommended)

# interactive quickstart (flow does onboarding + integration probes)
synapse onboard --flow quickstart

# CI/non-interactive default setup
synapse onboard --flow quickstart --non-interactive --json

# advanced flow with explicit defaults
synapse onboard --flow advanced \
  --policy-template private \
  --default-scope private \
  --default-sensitive on \
  --enable-service \
  --service-schedule daily

Python API is straightforward:

from synapse import Synapse
s = Synapse()
s.remember("I prefer dark mode")
print(s.recall("what theme?"))

Core flow model

  • Vault-aware memory: isolate by user_id when enabled.
  • Review-first path for sensitive/uncertain captures via the Inbox.
  • Natural language forgetting for targeted cleanup.
  • Scope + sensitive controls with conservative defaults.
  • Portable formats (.brain, checkpoints, imports/exports).
  • Federation primitives (synapse federate, sync, push, pull) available when configured.
  • Zero-LLM indexing for core recall/ingest.

Runtime and service management

  • synapse up --port <port> starts the appliance daemon (MCP stdio server + HTTP JSON-RPC fallback)
  • synapse down stops it.
  • synapse status shows running status and basic store stats.
  • synapse service install|uninstall|status manages autostart (launchd / systemd).

Runtime defaults are local-only; integrations may add network calls only when used.

Integrations (client + contract metadata)

synapse install and synapse integrations are now split by use-case:

# quick probe + integration ops
synapse integrations list --db ~/.synapse
synapse integrations list --json

# install / verify / repair / open flows for detected clients
synapse integrations install claude
synapse integrations test cursor
synapse integrations repair windsurf
synapse integrations open continue

synapse integrations list --json includes connector contract metadata (type, tier, commands, capabilities, doctor_checks, example_prompt) for supported built-ins.

synapse install still handles broader install targets (for example telegram, ollama, nanoclaw) as a direct installer path.

Policy receipts (Phase-1)

Audit trail for permit decisions is now available from policy hooks.

synapse permit receipts --last 5
synapse permit receipts --last 5 --json

Notes:

  • Receipts are written to <db>/receipts/permit_receipts.jsonl.
  • Schema is stable (synapse.permit.receipt.v1) for JSON output.
  • This is a Phase-1 implementation: it records enforcement decisions and reasons, but log volume and retention policies are intentionally minimal.

MCP server

The project exposes MCP tools via:

  • synapse serve (default appliance mode)
  • synapse serve --http --port 8765 (HTTP JSON-RPC)
  • synapse-mcp wrapper (managed launcher at ~/.synapse/bin/synapse-mcp)

Use:

synapse serve                 # local stdio-compatible mode
synapse serve --http --port 8765

For client integrations, see synapse install <client> and the onboarding docs.

Key CLI commands

# onboarding
synapse onboard --flow quickstart
synapse onboard --flow advanced --non-interactive

# integrations & connectors
synapse integrations list --json
synapse integrations install claude
synapse integrations test claude
synapse integrations repair claude

# policy and runtime
synapse permit receipts --last 10 --json
synapse up --port 8765
synapse down
synapse status
synapse service install

# runtime memory operations (examples)
synapse ingest "User prefers concise responses"
synapse clip "Meeting notes: ..."
synapse watch --clipboard
synapse inbox list
synapse nlforget "forget my old job" --dry-run
synapse pack --topic project-x --range 30d

Data model highlights (for API users)

  • Contextual recall (Synapse.recall) supports multiple retrieval paths and query options.
  • Structured triples + graph indexing are available for explainability and consistency checks.
  • Contradiction detection and belief lineage expose confidence/conflicts for recall.
  • Scope policy can enforce conservative output behavior at runtime.

Python examples

from synapse import Synapse

s = Synapse("~/.synapse/synapse_store")

# memory with scope
s.remember("Team deadline is Friday", scope="shared", shared_with=["team:ops"])

# compile context for downstream LLM call
pack = s.compile_context("Prepare a concise status update", budget=1800, policy="balanced")
system_prompt = pack.to_system_prompt()

# maintenance + safety
report = s.sleep(verbose=True)
print(report.to_digest())

Compatibility and links

  • Docs: this README and README_MCP.md
  • Examples: examples/, docs/, integrations/
  • Tests: tests/ and docs/benchmarks/
  • Installable on: macOS / Linux (and compatible Python 3.10+)

Security and licensing

See SECURITY.md. Synapse remains MIT-licensed under LICENSE.

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

synapse_ai_memory-0.13.1.tar.gz (373.7 kB view details)

Uploaded Source

Built Distribution

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

synapse_ai_memory-0.13.1-py3-none-any.whl (345.6 kB view details)

Uploaded Python 3

File details

Details for the file synapse_ai_memory-0.13.1.tar.gz.

File metadata

  • Download URL: synapse_ai_memory-0.13.1.tar.gz
  • Upload date:
  • Size: 373.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for synapse_ai_memory-0.13.1.tar.gz
Algorithm Hash digest
SHA256 a15c517a455b35a6607e43432b1b0a830d29bb26f6ea5e8d6e94f85366134b4d
MD5 e7f3711fc663e98216cdc0a01548dd64
BLAKE2b-256 58ac8fd2c513e285a6ab6b71a268f0a2959aa2e2e2f080cf32b1d7066206b917

See more details on using hashes here.

File details

Details for the file synapse_ai_memory-0.13.1-py3-none-any.whl.

File metadata

File hashes

Hashes for synapse_ai_memory-0.13.1-py3-none-any.whl
Algorithm Hash digest
SHA256 83b530e17f2b1b6ff952411ab97752004030c6b92481042efffec8d5403bbe8a
MD5 2d253e316f71c7b773ab9c6e7da3b889
BLAKE2b-256 d4c8daf5cb05a0007d05fc911c08c56bc7037214e33e0abe7a87dab05f4aafe0

See more details on using hashes here.

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