@prom.codes/memory-mcp 0.7.1 → 0.7.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -30
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -7,45 +7,46 @@ procedures survive context-window resets. Records live in a local SQLite
|
|
|
7
7
|
database (`~/.prometheus/memory.db`); project-scoped memories are mirrored
|
|
8
8
|
as git-versioned markdown under `.prometheus/memories/` in your repo.
|
|
9
9
|
|
|
10
|
-
## Quick start
|
|
11
|
-
|
|
12
|
-
```jsonc
|
|
13
|
-
// Claude Desktop / Cursor MCP config — dock under the server name `memory`
|
|
14
|
-
// so the tools resolve to memory_read / memory_write / … (no double prefix).
|
|
15
|
-
{
|
|
16
|
-
"mcpServers": {
|
|
17
|
-
"memory": {
|
|
18
|
-
"command": "npx",
|
|
19
|
-
"args": ["-y", "@prom.codes/memory-mcp@latest"],
|
|
20
|
-
"env": {
|
|
21
|
-
"PROMETHEUS_WORKSPACE_ROOT": "/absolute/path/to/your/repo",
|
|
22
|
-
"VOYAGE_API_KEY": "pa-… // optional: enables semantic recall (search)"
|
|
23
|
-
}
|
|
24
|
-
}
|
|
25
|
-
}
|
|
26
|
-
}
|
|
27
|
-
```
|
|
10
|
+
## Quick start (Claude Code)
|
|
28
11
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
`PROMETHEUS_API_KEY` to route embeddings through the metered Prometheus proxy.
|
|
12
|
+
```bash
|
|
13
|
+
claude mcp add memory --env PROMETHEUS_API_KEY=prom_live_… -- npx -y @prom.codes/memory-mcp@latest
|
|
14
|
+
```
|
|
33
15
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
16
|
+
Docks under the server name `memory`, so tools resolve to `memory_read` /
|
|
17
|
+
`memory_write` / … `claude mcp add` defaults to local scope; add
|
|
18
|
+
`--scope project` for a committable `.mcp.json`. Other hosts (Cursor, VS Code)
|
|
19
|
+
use the same command/args in their own config.
|
|
20
|
+
|
|
21
|
+
Then ask your agent to run `memory_setup` once per workspace — it installs the
|
|
22
|
+
memory protocol into your runtime rule files (CLAUDE.md, .cursor/rules,
|
|
23
|
+
AGENTS.md) so the agent reads memory at session start and captures learnings at
|
|
24
|
+
session end.
|
|
25
|
+
|
|
26
|
+
## Configuration
|
|
27
|
+
|
|
28
|
+
- **Works with no key at all** — boots keyword-only (FTS5) and fully offline. A
|
|
29
|
+
`PROMETHEUS_API_KEY` (real `prom_live_<tag>_<secret>` from
|
|
30
|
+
[app.prom.codes/app/api-keys](https://app.prom.codes)) adds **semantic** recall
|
|
31
|
+
via the managed proxy — the same one key as Context and Saver.
|
|
32
|
+
- **Workspace root is auto-detected** (Claude Code `CLAUDE_PROJECT_DIR` / MCP
|
|
33
|
+
`roots`) — no need to set `PROMETHEUS_WORKSPACE_ROOT`.
|
|
34
|
+
- **Optional quality levers** (documented): `PROMETHEUS_MEMORY_RERANK_PROVIDER`
|
|
35
|
+
(cross-encoder rerank — reranked recall ties full-context at ~28× fewer tokens
|
|
36
|
+
on LoCoMo) and `PROMETHEUS_MEMORY_REWRITE_PROVIDER` (HyDE). Temporal-intent
|
|
37
|
+
ranking ("latest/earliest" queries) is **on by default**; disable with
|
|
38
|
+
`PROMETHEUS_MEMORY_TEMPORAL=off`.
|
|
38
39
|
|
|
39
40
|
Tools (docked as `memory`): `memory_read`, `memory_write`, `memory_capture`,
|
|
40
41
|
`memory_search`, `memory_list`, `memory_delete`, `memory_setup`. Secrets are
|
|
41
|
-
rejected on every write. Your memories never leave your machine
|
|
42
|
+
rejected on every write. Your memories never leave your machine (only short
|
|
43
|
+
query/record text transits when embeddings are enabled).
|
|
42
44
|
|
|
43
45
|
## Native modules
|
|
44
46
|
|
|
45
47
|
Uses `better-sqlite3` (native). Prebuilt binaries are fetched automatically on
|
|
46
48
|
common platforms (macOS x64/arm64, Linux x64/arm64, Windows x64) — no compiler
|
|
47
49
|
needed. On an unsupported platform/Node ABI, install C/C++ build tools so the
|
|
48
|
-
module can compile (Windows:
|
|
49
|
-
Requires Node ≥ 20.10.
|
|
50
|
+
module can compile (Windows: VS Build Tools). Requires Node ≥ 20.10.
|
|
50
51
|
|
|
51
|
-
Docs: https://prom.codes/docs
|
|
52
|
+
Docs: https://prom.codes/docs/mcp/memory
|