Skip to content

Commit eebc269

Browse files
docs(integrations): rename Mimir Memory → Perseus Vault Memory (supersedes #1877) (#1928)
* docs(integrations): rename Mimir Memory -> Perseus Vault Memory (supersedes #1877) * docs(integrations): address review on perseus-vault memory page - Restore "Use cases" section - Add intro phrases before Installation and Use-with-agent code blocks - Point the binary prereq at the Installation section - Drop the non-existent `cargo install perseus-vault` step - Remove the "(formerly Mimir/Mneme)" lineage note - Add trailing newline * docs(integrations): restore Perseus live context (optional) section Carry over the optional [perseus] extra / perseus_context_agent section from the original page, updated to the Perseus Vault names. --------- Co-authored-by: Kristopher Overholt <koverholt@google.com>
1 parent 7e72859 commit eebc269

5 files changed

Lines changed: 61 additions & 44 deletions

File tree

docs/integrations/assets/mimir.svg

Lines changed: 0 additions & 7 deletions
This file was deleted.
Lines changed: 21 additions & 0 deletions
Loading
Lines changed: 37 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
---
2-
catalog_title: Mimir Memory
2+
catalog_title: Perseus Vault Memory
33
catalog_description: Add persistent, local, encrypted cross-session memory to ADK agents
4-
catalog_icon: /integrations/assets/mimir.svg
4+
catalog_icon: /integrations/assets/perseus-vault.svg
55
catalog_tags: ["data"]
66
---
77

8-
# Mimir Memory integration for ADK
8+
# Perseus Vault Memory integration for ADK
99

1010
<div class="language-support-tag">
1111
<span class="lst-supported">Supported in ADK</span><span class="lst-python">Python</span>
1212
</div>
1313

14-
The [`adk-mimir-memory`](https://github.com/Perseus-Computing-LLC/adk-mimir-memory)
14+
The [`adk-perseus-vault-memory`](https://github.com/Perseus-Computing-LLC/adk-mimir-memory)
1515
integration connects your ADK agent to
16-
[Mimir](https://github.com/Perseus-Computing-LLC/mimir), a persistent,
17-
cross-session memory backend. Backed by a single Rust binary with an embedded
18-
SQLite database, it requires **zero cloud dependencies**, and everything runs
19-
locally. Memory is encrypted at rest with AES-256-GCM, and search combines FTS5
20-
keyword matching with dense vector retrieval.
16+
[Perseus Vault](https://github.com/Perseus-Computing-LLC/perseus-vault), a
17+
persistent, cross-session memory backend. Backed by a single Rust binary with an
18+
embedded SQLite database, it requires **zero cloud dependencies**, and everything
19+
runs locally. Memory is encrypted at rest with AES-256-GCM, and search combines
20+
FTS5 keyword matching with dense vector retrieval.
2121

2222
## Use cases
2323

2424
- **Persistent agent memory across restarts**: Sessions survive process
2525
restarts, and agents recall past conversations automatically
26-
- **Private, air-gapped deployments**: No cloud dependency, and Mimir runs
27-
entirely on your machine with optional AES-256-GCM encryption
26+
- **Private, air-gapped deployments**: No cloud dependency, and Perseus Vault
27+
runs entirely on your machine with optional AES-256-GCM encryption
2828
- **Hybrid search across memories**: Combine keyword (FTS5/BM25) and semantic
2929
(dense vector) search to find relevant past interactions
3030
- **Workspace-aware agents**: Pair with Perseus for agents that know about your
@@ -33,29 +33,31 @@ keyword matching with dense vector retrieval.
3333
## Prerequisites
3434

3535
- Python 3.10+
36-
- The `mimir` binary (see [Installation](#installation))
36+
- The `perseus-vault` binary (see [Installation](#installation))
3737
- `google-adk>=1.0.0`
3838

3939
## Installation
4040

4141
Install the Python package:
4242

4343
```bash
44-
pip install adk-mimir-memory
44+
pip install adk-perseus-vault-memory
4545
```
4646

47-
Then install the `mimir` binary: download the build for your platform from the
48-
[Mimir releases page](https://github.com/Perseus-Computing-LLC/mimir/releases)
49-
and place it on your `PATH`. The service looks for `mimir` by default, or pass
50-
`mimir_binary="/absolute/path/to/mimir"` to `MimirMemoryService`.
47+
Then install the `perseus-vault` binary: download the build for your platform
48+
from the
49+
[releases page](https://github.com/Perseus-Computing-LLC/perseus-vault/releases)
50+
and place it on your `PATH`. The service looks for `perseus-vault` by default, or
51+
pass `vault_binary="/absolute/path/to/perseus-vault"` to
52+
`PerseusVaultMemoryService`.
5153

5254
## Use with agent
5355

54-
Create the `MimirMemoryService`, pass it to your `Runner`, and give the agent
55-
the `load_memory` tool so it can recall past sessions:
56+
Create the `PerseusVaultMemoryService`, pass it to your `Runner`, and give the
57+
agent the `load_memory` tool so it can recall past sessions:
5658

5759
```python
58-
from adk_mimir_memory import MimirMemoryService
60+
from adk_perseus_vault_memory import PerseusVaultMemoryService
5961
from google.adk.agents import Agent
6062
from google.adk.runners import Runner
6163
from google.adk.sessions import InMemorySessionService
@@ -70,30 +72,30 @@ agent = Agent(
7072

7173
runner = Runner(
7274
agent=agent,
73-
app_name="mimir_app",
75+
app_name="perseus_vault_app",
7476
session_service=InMemorySessionService(),
75-
memory_service=MimirMemoryService(db_path="~/.adk/mimir.db"),
77+
memory_service=PerseusVaultMemoryService(db_path="~/.adk/vault.db"),
7678
)
7779
```
7880

79-
After a session completes, call
80-
`await memory_service.add_session_to_memory(session)` to persist it. The agent
81-
recalls relevant memories in later sessions through the `load_memory` tool. See
82-
[ADK memory](/sessions/memory/) for the full ingest-and-recall flow.
81+
After a session completes, call `await memory_service.add_session_to_memory(session)`
82+
to persist it; the agent recalls memories in later sessions through the
83+
`load_memory` tool. See [ADK memory](/sessions/memory/) for the full
84+
ingest-and-recall flow.
8385

8486
### Perseus live context (optional)
8587

8688
For live workspace awareness, install the `perseus` extra:
8789

8890
```bash
89-
pip install adk-mimir-memory[perseus]
91+
pip install adk-perseus-vault-memory[perseus]
9092
```
9193

9294
Then use the prebuilt `perseus_context_agent`, which resolves `@file`,
9395
`@search`, and `@memory` directives at inference time:
9496

9597
```python
96-
from adk_mimir_memory.perseus_context import perseus_context_agent
98+
from adk_perseus_vault_memory.perseus_context import perseus_context_agent
9799
from google.adk.runners import Runner
98100
from google.adk.sessions import InMemorySessionService
99101

@@ -104,7 +106,7 @@ runner = Runner(
104106
agent=perseus_context_agent,
105107
app_name="perseus_app",
106108
session_service=InMemorySessionService(),
107-
memory_service=MimirMemoryService(db_path="~/.adk/mimir.db"),
109+
memory_service=PerseusVaultMemoryService(db_path="~/.adk/vault.db"),
108110
)
109111
```
110112

@@ -136,13 +138,13 @@ session = await runner.session_service.create_session(
136138
| Backend | Dependencies | At-rest encryption | Search | Hosting |
137139
|---|---|---|---|---|
138140
| **InMemoryMemoryService** | None | Not persisted | Keyword | Local (ephemeral) |
139-
| **VertexAiMemoryBankService** | Google Cloud | Google-managed (CMEK optional) | Semantic (Gemini) | Google Cloud |
140-
| **VertexAiRagMemoryService** | Google Cloud | Google-managed (CMEK optional) | Vector similarity | Google Cloud |
141-
| **MimirMemoryService** | `mimir` binary | Local AES-256-GCM (optional) | Hybrid (FTS5 + dense) | Local |
141+
| **VertexAiMemoryBankService** | Google Cloud | Google-managed | Semantic (Gemini) | Google Cloud |
142+
| **VertexAiRagMemoryService** | Google Cloud | Google-managed | Vector similarity | Google Cloud |
143+
| **PerseusVaultMemoryService** | `perseus-vault` binary | Local AES-256-GCM | Hybrid (FTS5 + dense) | Local |
142144

143145
## Resources
144146

145-
- [adk-mimir-memory on GitHub](https://github.com/Perseus-Computing-LLC/adk-mimir-memory)
146-
- [adk-mimir-memory on PyPI](https://pypi.org/project/adk-mimir-memory/)
147-
- [Mimir (backing service)](https://github.com/Perseus-Computing-LLC/mimir)
147+
- [adk-perseus-vault-memory on GitHub](https://github.com/Perseus-Computing-LLC/adk-mimir-memory)
148+
- [adk-perseus-vault-memory on PyPI](https://pypi.org/project/adk-perseus-vault-memory/)
149+
- [Perseus Vault (backing service)](https://github.com/Perseus-Computing-LLC/perseus-vault)
148150
- [Perseus Context integration](/integrations/perseus/)

docs/integrations/perseus.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ retrieval index, no embeddings, and no extra LLM round-trip. Everything runs
2121
locally.
2222

2323
Perseus is a context compiler, not a memory or RAG backend. For persistent
24-
cross-session memory, pair it with its companion, [Mimir](/integrations/mimir/).
24+
cross-session memory, pair it with its companion, [Perseus Vault](/integrations/perseus-vault/).
2525

2626
## Use cases
2727

@@ -164,4 +164,4 @@ agent = Agent(
164164
- [adk-perseus-context on GitHub](https://github.com/Perseus-Computing-LLC/adk-perseus-context)
165165
- [adk-perseus-context on PyPI](https://pypi.org/project/adk-perseus-context/)
166166
- [Perseus (context engine)](https://github.com/Perseus-Computing-LLC/perseus)
167-
- [Mimir Memory integration](/integrations/mimir/)
167+
- [Perseus Vault Memory integration](/integrations/perseus-vault/)

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -206,6 +206,7 @@ plugins:
206206
'observability/freeplay.md': 'integrations/freeplay.md'
207207
'observability/mlflow.md': 'integrations/mlflow-tracing.md'
208208
'integrations/mlflow.md': 'integrations/mlflow-tracing.md'
209+
'integrations/mimir.md': 'integrations/perseus-vault.md'
209210
'observability/monocle.md': 'integrations/monocle.md'
210211
'observability/phoenix.md': 'integrations/phoenix.md'
211212
'observability/weave.md': 'integrations/weave.md'

0 commit comments

Comments
 (0)