@dangvv/openclaw-mem0 0.3.0

package/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to the `@mem0/openclaw-mem0` plugin will be documented in this file.
+
+## [0.3.0] - 2026-03-10
+
+### Fixed
+- Updated `mem0ai` dependency which includes the sqlite3 to better-sqlite3 migration for native binding resolution (#4270)
+
+## [0.2.0] - 2026-03-09
+
+### Added
+- "Understanding userId" section in docs clarifying that `userId` is user-defined
+- Per-agent memory isolation for multi-agent setups via `agentId`
+- Regression tests for per-agent isolation helpers
+
+### Changed
+- Updated config examples to use concrete `userId` values instead of placeholders
+
+### Fixed
+- Migrated platform search to Mem0 v2 API
+
+## [0.1.2] - 2026-02-19
+
+### Added
+- Source field for openclaw memory entries
+
+### Fixed
+- Auto-recall injection and auto-capture message drop
+
+## [0.1.0] - 2026-02-02
+
+### Added
+- Initial release of the OpenClaw Mem0 plugin
+- Platform mode (Mem0 Cloud) and open-source mode support
+- Auto-recall: inject relevant memories before each turn
+- Auto-capture: store facts after each turn
+- Configurable `topK`, `threshold`, and `apiVersion` options

package/README.md

@@ -0,0 +1,222 @@
+# @mem0/openclaw-mem0
+
+Long-term memory for [OpenClaw](https://github.com/openclaw/openclaw) agents, powered by [Mem0](https://mem0.ai).
+
+Your agent forgets everything between sessions. This plugin fixes that. It watches conversations, extracts what matters, and brings it back when relevant — automatically.
+
+## How it works
+
+<p align="center">
+  <img src="../docs/images/openclaw-architecture.png" alt="Architecture" width="800" />
+</p>
+
+**Auto-Recall** — Before the agent responds, the plugin searches Mem0 for memories that match the current message and injects them into context.
+
+**Auto-Capture** — After the agent responds, the plugin sends the exchange to Mem0. Mem0 decides what's worth keeping — new facts get stored, stale ones updated, duplicates merged.
+
+Both run silently. No prompting, no configuration, no manual calls.
+
+### Short-term vs long-term memory
+
+Memories are organized into two scopes:
+
+- **Session (short-term)** — Auto-capture stores memories scoped to the current session via Mem0's `run_id` / `runId` parameter. These are contextual to the ongoing conversation and automatically recalled alongside long-term memories.
+
+- **User (long-term)** — The agent can explicitly store long-term memories using the `memory_store` tool (with `longTerm: true`, the default). These persist across all sessions for the user.
+
+During **auto-recall**, the plugin searches both scopes and presents them separately — long-term memories first, then session memories — so the agent has full context.
+
+The agent tools (`memory_search`, `memory_list`) accept a `scope` parameter (`"session"`, `"long-term"`, or `"all"`) to control which memories are queried. The `memory_store` tool accepts a `longTerm` boolean (default: `true`) to choose where to store.
+
+All new parameters are optional and backward-compatible — existing configurations work without changes.
+
+### Per-agent memory isolation
+
+In multi-agent setups, each agent automatically gets its own memory namespace. Session keys following the pattern `agent:<agentId>:<uuid>` are parsed to derive isolated namespaces (`${userId}:agent:${agentId}`). Single-agent deployments are unaffected — plain session keys and `agent:main:*` keys resolve to the configured `userId`.
+
+**How it works:**
+
+- The agent's session key is inspected on every recall/capture cycle
+- If the key matches `agent:<name>:<uuid>`, memories are stored under `userId:agent:<name>`
+- Different agents never see each other's memories unless explicitly queried
+
+**Explicit cross-agent queries:**
+
+All memory tools (`memory_search`, `memory_store`, `memory_list`, `memory_forget`) accept an optional `agentId` parameter to query another agent's namespace:
+
+```
+memory_search({ query: "user's tech stack", agentId: "researcher" })
+```
+
+Resolution priority: explicit `agentId` > explicit `userId` > session-derived > configured default.
+
+## Setup
+
+```bash
+openclaw plugins install @mem0/openclaw-mem0
+```
+
+### Understanding `userId`
+
+The `userId` field is a **string you choose** to uniquely identify the user whose memories are being stored. It is **not** something you look up in the Mem0 dashboard — you define it yourself.
+
+Pick any stable, unique identifier for the user. Common choices:
+
+- Your application's internal user ID (e.g. `"user_123"`, `"alice@example.com"`)
+- A UUID (e.g. `"550e8400-e29b-41d4-a716-446655440000"`)
+- A simple username (e.g. `"alice"`)
+
+All memories are scoped to this `userId` — different values create separate memory namespaces. If you don't set it, it defaults to `"default"`, which means all users share the same memory space.
+
+> **Tip:** In a multi-user application, set `userId` dynamically per user (e.g. from your auth system) rather than hardcoding a single value.
+
+### Platform (Mem0 Cloud)
+
+Get an API key from [app.mem0.ai](https://app.mem0.ai), then add to your `openclaw.json`:
+
+```json5
+// plugins.entries
+"openclaw-mem0": {
+  "enabled": true,
+  "config": {
+    "apiKey": "${MEM0_API_KEY}",
+    "userId": "alice"  // any unique identifier you choose for this user
+  }
+}
+```
+
+### Open-Source (Self-hosted)
+
+No Mem0 key needed. Requires `OPENAI_API_KEY` for default embeddings/LLM.
+
+```json5
+"openclaw-mem0": {
+  "enabled": true,
+  "config": {
+    "mode": "open-source",
+    "userId": "alice"  // any unique identifier you choose for this user
+  }
+}
+```
+
+Sensible defaults out of the box. To customize the embedder, vector store, or LLM:
+
+```json5
+"config": {
+  "mode": "open-source",
+  "userId": "your-user-id",
+  "oss": {
+    "embedder": { "provider": "openai", "config": { "model": "text-embedding-3-small" } },
+    "vectorStore": { "provider": "qdrant", "config": { "host": "localhost", "port": 6333 } },
+    "llm": { "provider": "openai", "config": { "model": "gpt-4o" } }
+  }
+}
+```
+
+To enable graph memory in open-source mode, set `enableGraph: true` and provide a graph backend in `oss.graphStore`:
+
+```json5
+"config": {
+  "mode": "open-source",
+  "userId": "your-user-id",
+  "enableGraph": true,
+  "oss": {
+    "graphStore": {
+      "provider": "neo4j",
+      "config": {
+        "url": "${NEO4J_URL}",
+        "username": "${NEO4J_USERNAME}",
+        "password": "${NEO4J_PASSWORD}",
+        "database": "neo4j"
+      }
+    }
+  }
+}
+```
+
+When graph memory is enabled in OSS mode, Mem0 search returns normal vector hits plus related entities in a `relations` payload. This plugin includes those relations in `memory_search` output and auto-recall context.
+
+All `oss` fields are optional. See [Mem0 OSS docs](https://docs.mem0.ai/open-source/node-quickstart) for providers.
+
+## Agent tools
+
+The agent gets five tools it can call during conversations:
+
+| Tool | Description |
+|------|-------------|
+| `memory_search` | Search memories by natural language. Optional `agentId` to scope to a specific agent. |
+| `memory_list` | List all stored memories for a user. Optional `agentId` to scope to a specific agent. |
+| `memory_store` | Explicitly save a fact. Optional `agentId` to store under a specific agent's namespace. |
+| `memory_get` | Retrieve a memory by ID |
+| `memory_forget` | Delete by ID or by query. Optional `agentId` to scope deletion to a specific agent. |
+
+## CLI
+
+```bash
+# Search all memories (long-term + session)
+openclaw mem0 search "what languages does the user know"
+
+# Search only long-term memories
+openclaw mem0 search "what languages does the user know" --scope long-term
+
+# Search only session/short-term memories
+openclaw mem0 search "what languages does the user know" --scope session
+
+# Stats
+openclaw mem0 stats
+
+# Search a specific agent's memories
+openclaw mem0 search "user preferences" --agent researcher
+
+# Stats for a specific agent
+openclaw mem0 stats --agent researcher
+```
+
+## Options
+
+### General
+
+| Key | Type | Default | |
+|-----|------|---------|---|
+| `mode` | `"platform"` \| `"open-source"` | `"platform"` | Which backend to use |
+| `userId` | `string` | `"default"` | Any unique identifier you choose for the user (e.g. `"alice"`, `"user_123"`). All memories are scoped to this value. Not found in any dashboard — you define it yourself. |
+| `autoRecall` | `boolean` | `true` | Inject memories before each turn |
+| `autoCapture` | `boolean` | `true` | Store facts after each turn |
+| `topK` | `number` | `5` | Max memories per recall |
+| `searchThreshold` | `number` | `0.3` | Min similarity (0–1) |
+
+### Platform mode
+
+| Key | Type | Default | |
+|-----|------|---------|---|
+| `apiKey` | `string` | — | **Required.** Mem0 API key (supports `${MEM0_API_KEY}`) |
+| `orgId` | `string` | — | Organization ID |
+| `projectId` | `string` | — | Project ID |
+| `enableGraph` | `boolean` | `false` | Entity graph for relationships. In open-source mode, requires `oss.graphStore`. |
+| `customInstructions` | `string` | *(built-in)* | Extraction rules — what to store, how to format |
+| `customCategories` | `object` | *(12 defaults)* | Category name → description map for tagging |
+
+### Open-source mode
+
+Works with zero extra config. The `oss` block lets you swap out any component:
+
+| Key | Type | Default | |
+|-----|------|---------|---|
+| `customPrompt` | `string` | *(built-in)* | Extraction prompt for memory processing |
+| `oss.embedder.provider` | `string` | `"openai"` | Embedding provider (`"openai"`, `"ollama"`, etc.) |
+| `oss.embedder.config` | `object` | — | Provider config: `apiKey`, `model`, `baseURL` |
+| `oss.vectorStore.provider` | `string` | `"memory"` | Vector store (`"memory"`, `"qdrant"`, `"chroma"`, etc.) |
+| `oss.vectorStore.config` | `object` | — | Provider config: `host`, `port`, `collectionName`, `dimension` |
+| `oss.llm.provider` | `string` | `"openai"` | LLM provider (`"openai"`, `"anthropic"`, `"ollama"`, etc.) |
+| `oss.llm.config` | `object` | — | Provider config: `apiKey`, `model`, `baseURL`, `temperature` |
+| `oss.graphStore.provider` | `string` | — | Graph backend (`"neo4j"`, `"memgraph"`, `"neptune"`, `"kuzu"`, etc.) |
+| `oss.graphStore.config` | `object` | — | Provider config: backend connection details such as `url`, `username`, `password`, `database` |
+| `oss.graphStore.customPrompt` | `string` | — | Optional graph extraction prompt override |
+| `oss.graphStore.threshold` | `number` | provider default | Optional graph matching threshold |
+| `oss.historyDbPath` | `string` | — | SQLite path for memory edit history |
+
+Everything inside `oss` is optional — defaults use OpenAI embeddings (`text-embedding-3-small`), in-memory vector store, and OpenAI LLM. Override only what you need.
+
+## License
+
+Apache 2.0