@jcyamacho/agent-memory 0.1.0 → 0.3.0
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 +29 -27
- package/dist/index.js +398 -3891
- package/package.json +5 -9
package/README.md
CHANGED
|
@@ -3,14 +3,15 @@
|
|
|
3
3
|
Persistent memory for MCP-powered coding agents.
|
|
4
4
|
|
|
5
5
|
`agent-memory` is a stdio MCP server that gives your LLM durable memory backed
|
|
6
|
-
by
|
|
7
|
-
decisions across sessions.
|
|
6
|
+
by Markdown files on disk. It helps your agent remember preferences, project
|
|
7
|
+
context, and prior decisions across sessions.
|
|
8
8
|
|
|
9
9
|
It exposes four tools:
|
|
10
10
|
|
|
11
11
|
- `remember` -> save facts, decisions, preferences, and project context
|
|
12
12
|
- `review` -> load workspace and global memories sorted by most recently updated
|
|
13
|
-
- `revise` -> update an existing memory when
|
|
13
|
+
- `revise` -> update an existing memory when its content changes or when it
|
|
14
|
+
should become global
|
|
14
15
|
- `forget` -> delete a memory that is no longer relevant
|
|
15
16
|
|
|
16
17
|
## Quick Start
|
|
@@ -55,25 +56,21 @@ targets the habits models most commonly miss:
|
|
|
55
56
|
`memory_forget` to keep memories accurate.
|
|
56
57
|
- Pass `workspace` on `memory_remember` for project-scoped memory. Omit it
|
|
57
58
|
only for facts that apply across projects.
|
|
59
|
+
- Remember preferences, confirmed approaches, and decisions with reasoning
|
|
60
|
+
that would be lost after the session.
|
|
61
|
+
- Revise content when a fact changes, promote a project-scoped memory to
|
|
62
|
+
global only when it truly applies across projects, and forget it when it is
|
|
63
|
+
no longer relevant.
|
|
58
64
|
- Do not store secrets, temporary task state, or facts obvious from current
|
|
59
65
|
code or git history.
|
|
60
66
|
```
|
|
61
67
|
|
|
62
|
-
##
|
|
68
|
+
## Mutating Tool Output
|
|
63
69
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
Opens at `http://localhost:6580`. Use `--port` to change:
|
|
71
|
-
|
|
72
|
-
```bash
|
|
73
|
-
npx -y @jcyamacho/agent-memory@latest --ui --port 9090
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
The web UI uses the same database as the MCP server.
|
|
70
|
+
`remember`, `revise`, and `forget` return the full affected memory
|
|
71
|
+
as XML with `updated_at` and scope information so clients that hide tool-call
|
|
72
|
+
arguments can still see what changed.
|
|
73
|
+
`forget` includes `deleted="true"` on the returned `<memory>` element.
|
|
77
74
|
|
|
78
75
|
## How Review Works
|
|
79
76
|
|
|
@@ -87,28 +84,33 @@ workspace queries so linked worktrees still match repo-scoped memories exactly.
|
|
|
87
84
|
|
|
88
85
|
## Configuration
|
|
89
86
|
|
|
90
|
-
###
|
|
87
|
+
### Store Location
|
|
91
88
|
|
|
92
|
-
By default,
|
|
89
|
+
By default, memories are stored under:
|
|
93
90
|
|
|
94
91
|
```text
|
|
95
|
-
~/.config/agent-memory/
|
|
92
|
+
~/.config/agent-memory/
|
|
96
93
|
```
|
|
97
94
|
|
|
98
95
|
Override it with:
|
|
99
96
|
|
|
100
97
|
```bash
|
|
101
|
-
|
|
98
|
+
AGENT_MEMORY_STORE_PATH=/absolute/path/to/agent-memory
|
|
102
99
|
```
|
|
103
100
|
|
|
104
|
-
|
|
101
|
+
The store layout is:
|
|
105
102
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
-
|
|
103
|
+
```text
|
|
104
|
+
<store>/
|
|
105
|
+
globals/<memory-id>.md
|
|
106
|
+
workspaces/<encoded-workspace>/<memory-id>.md
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
Set `AGENT_MEMORY_STORE_PATH` when you want to:
|
|
109
110
|
|
|
110
|
-
|
|
111
|
-
|
|
111
|
+
- keep memory in a project-specific location
|
|
112
|
+
- share a memory store across multiple clients
|
|
113
|
+
- keep the Markdown files somewhere easier to back up or inspect
|
|
112
114
|
|
|
113
115
|
## License
|
|
114
116
|
|