Skip to main content

MongoDB Atlas-backed thread/session persistence + semantic/episodic vector memory for VRSEN Agency Swarm.

Project description

agency-swarm-mongodb

⚠️ ALPHA — NOT AN OFFICIAL MONGODB PRODUCT. This integration is in Alpha and is not a supported or official MongoDB product. Use at your own risk.

MongoDB Atlas–backed persistence and vector memory for VRSEN Agency Swarm.

  • MongoThreadStore — drop-in load_threads_callback / save_threads_callback for the Agency class: persist entire conversations to MongoDB and restore them across restarts.
  • MongoMemoryStore (new in 0.1.1) — semantic / episodic long-term memory with Atlas Vector Search recall. Embedding source-agnostic: bring your own query vector (default) or enable Atlas Automated Embedding (server-side embeddings, no client code).

Why

Agency Swarm persists conversations through two Agency hooks but ships no database backend (only a file-based example). MongoThreadStore is that backend: one document per chat_id, idempotent upserts, optional TTL expiry — backed by MongoDB or Atlas.

Install

pip install agency-swarm-mongodb

Usage

from agency_swarm import Agency, Agent
from agency_swarm_mongodb import MongoThreadStore

store = MongoThreadStore("mongodb+srv://...", database_name="agency_swarm")
load_cb, save_cb = store.as_callbacks("user-123")   # chat_id captured in the closures

agency = Agency(
    Agent(name="Assistant", instructions="You are helpful."),
    load_threads_callback=load_cb,
    save_threads_callback=save_cb,
)

The store matches the Agency Swarm callback signatures exactly: load_threads_callback() -> list[dict] and save_threads_callback(messages: list[dict]) -> None.

Options

Arg Default Purpose
connection_string MongoDB / Atlas URI (required unless client given)
database_name agency_swarm Database name
collection_name threads Collection name
ttl_seconds None If set, TTL index on updated_at auto-expires idle chats
client None Bring your own MongoClient (then appName is not overwritten)

Document shape

{
  "_id": "user-123",          // chat_id
  "messages": [ /* full flat list, exactly as Agency Swarm emits */ ],
  "message_count": 12,
  "updated_at": { "$date": "..." }
}

Vector memory (MongoMemoryStore, new in 0.1.1)

Semantic / episodic long-term memory with Atlas Vector Search recall. The package never calls an embedding provider itself — you choose one of two first-class paths:

1. Bring your own vector (default). Embed with whatever provider you already use (OpenAI, Voyage SDK, Cohere, your agency's embedding client, …) and pass the vectors:

from agency_swarm_mongodb import MongoMemoryStore

mem = MongoMemoryStore("mongodb+srv://...")
mem.ensure_vector_index(num_dimensions=1024)        # one-time, on Atlas

mem.add_memory("user-123", "user", "Prefers window seats.",
               kind="semantic", embedding=my_provider.embed(text))

hits = mem.recall_semantic("user-123",
                           query_vector=my_provider.embed("seating?"), k=5)

2. Atlas Automated Embedding. Atlas generates embeddings server-side (no client embedding code); recall sends query text:

mem = MongoMemoryStore("mongodb+srv://...", auto_embed=True)   # default model: voyage-4
mem.ensure_vector_index()                            # builds an `autoEmbed` index

mem.add_memory("user-123", "user", "Prefers window seats.", kind="semantic")
hits = mem.recall_semantic("user-123", query="seating preferences", k=5)

There is no silent fallback: if you neither pass a query_vector nor enable auto_embed, recall raises ValueError. Episodic recency recall needs no vectors:

mem.add_memory("user-123", "assistant", "Booked the morning flight.", kind="episodic")
recent = mem.get_recent("user-123", n=10, kind="episodic")   # chronological

as_save_hook(scope) returns a save_threads_callback-compatible hook to mirror turns into episodic memory from an Agency.

Memory options

Arg Default Purpose
connection_string MongoDB / Atlas URI (required)
database_name agency_swarm Database name
collection_name memories Collection name
vector_search_index idx_agent_memory Atlas Vector Search index name
auto_embed False Enable Atlas Automated Embedding (recall by query text)
auto_embed_model voyage-4 Voyage model used by Automated Embedding
ttl_seconds None If set, TTL index on ts auto-expires old memories

Memory document shape

{
  "scope": "user-123",        // tenant / conversation / agent scope
  "kind": "semantic",         // "episodic" | "semantic"
  "role": "user",
  "content": "Prefers window seats.",
  "embedding": [ /* present only on the bring-your-own-vector path */ ],
  "ts": { "$date": "..." },
  "meta": {}
}

Demos

  • demo/custom_persistence_mongo.py — Mongo-backed mirror of Agency Swarm's custom_persistence.py: run a turn, simulate a restart, verify recall.
  • demo/agent_demo.py — a Gemini agent whose threads persist to Atlas, plus an Atlas Vector Search staffing tool over a team directory (Voyage 3.5 embeddings).
  • demo/memory_demo.pyMongoMemoryStore semantic + episodic recall on Atlas, runnable in both modes: bring-your-own Voyage vectors (default) or MEMORY_MODE=auto for Atlas Automated Embedding.
pip install -e ".[demo]"
pip install "openai-agents[litellm]" "litellm[proxy]"
# demo/.env: ATLAS_URI, VOYAGE_API_KEY, GEMINI_API_KEY
python demo/agent_demo.py
python demo/memory_demo.py                 # bring-your-own vectors
MEMORY_MODE=auto python demo/memory_demo.py  # Atlas Automated Embedding

Conventions

  • Connection appName: devrel-integ-agencyswarm-python (server-side attribution).
  • Driver handshake metadata: agency-swarm-mongodb (distinct from appName).

Tests

pip install -e ".[dev]"
pytest -q          # 25 tests, mongomock — no infra required

License

MIT

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

agency_swarm_mongodb-0.1.2.tar.gz (20.9 kB view details)

Uploaded Source

Built Distribution

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

agency_swarm_mongodb-0.1.2-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

Details for the file agency_swarm_mongodb-0.1.2.tar.gz.

File metadata

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

File hashes

Hashes for agency_swarm_mongodb-0.1.2.tar.gz
Algorithm Hash digest
SHA256 8afaa9c9f20176a7483698164ab5026125028efacd80208c77521140e5aaacba
MD5 d3ac91214a88d82fcaa1e5458c49102a
BLAKE2b-256 63505d90cb4e348706aa7d0ea9067e5ae6bde97bdf7e6ae84575b58520a03e76

See more details on using hashes here.

Provenance

The following attestation bundles were made for agency_swarm_mongodb-0.1.2.tar.gz:

Publisher: release.yml on mongodb-developer/agency-swarm-mongodb

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

File details

Details for the file agency_swarm_mongodb-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for agency_swarm_mongodb-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 83a3b7f25b4c76bb6fd98e4279f3459b0561a395cfc70fa42f5c170eb0ad0dd7
MD5 3dc66611d0796f3c2f72b84b1837f7ee
BLAKE2b-256 9df219e0d4f27312b811ac358005fa3644027b855c068e1568e9f681e5689f22

See more details on using hashes here.

Provenance

The following attestation bundles were made for agency_swarm_mongodb-0.1.2-py3-none-any.whl:

Publisher: release.yml on mongodb-developer/agency-swarm-mongodb

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