minnimemory 1.4.2 → 1.6.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/CHANGELOG.md +119 -0
- package/LICENSE +202 -61
- package/README.md +50 -31
- package/package.json +18 -6
- package/pkg/chunks/chunk-2QNXPBJM.js +232 -0
- package/pkg/chunks/chunk-VE2VOZ2V.js +60 -0
- package/pkg/chunks/mcpServer-6P2OSYJ4.js +2 -0
- package/pkg/cli.js +84 -79
- package/pkg/index.js +2 -2
- package/pkg/chunks/chunk-LN6FDCKX.js +0 -60
- package/pkg/chunks/chunk-Z7KWUKEZ.js +0 -214
- package/pkg/chunks/mcpServer-HEZQUR7M.js +0 -2
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,125 @@
|
|
|
3
3
|
All notable changes to the `minnimemory` package. Dates are publish dates; an entry that has not
|
|
4
4
|
been published yet says `unreleased` and gets its date on the day it goes out.
|
|
5
5
|
|
|
6
|
+
## 1.6.0 - unreleased
|
|
7
|
+
|
|
8
|
+
MinniMemoryMCP is open source. From this release the package is under the Apache License,
|
|
9
|
+
Version 2.0, and the source is at https://github.com/MinniAI-com/MinniMemoryMCP. Releases up to
|
|
10
|
+
1.5.0 keep the licence they shipped with.
|
|
11
|
+
|
|
12
|
+
- Changed: `LICENSE` is Apache-2.0. You may use, change and share the code. The Minni AI and
|
|
13
|
+
MinniMemory names and logos are not covered (`TRADEMARKS.md` in the repository).
|
|
14
|
+
- Changed: the one-line notice inside the instruction block `apply` writes now reads "Written by
|
|
15
|
+
minnimemory (c) 2026 MinniAI, Apache-2.0. Yours to keep, edit and publish." The next `apply`
|
|
16
|
+
on a compiled workspace rewrites that line; nothing else in your files moves because of it.
|
|
17
|
+
- Changed: `package.json` and the registry entry link the source repository; issues go there.
|
|
18
|
+
- Changed: every MCP tool carries `openWorldHint: false` (none reaches outside your machine;
|
|
19
|
+
the protocol's default says otherwise), and the server reports a title, `MinniMemoryMCP`, and
|
|
20
|
+
its website. The tool list costs 24 tokens more, 1,275 in all.
|
|
21
|
+
|
|
22
|
+
Rule packs (`doctor --policy`) stop reporting a repo for following its own rules.
|
|
23
|
+
|
|
24
|
+
- Fixed: MM021 no longer reports banned text in a sentence that forbids it ("never
|
|
25
|
+
`git add -A`"), in a list under a line that forbids it, or inside the pack's own required
|
|
26
|
+
rule. A real repo with a git rule pack had 10 findings, every one on a line that told the agent
|
|
27
|
+
not to run the command. A new `strict: true` on a banned entry keeps the old reading, every
|
|
28
|
+
mention a finding, for text that must never be in memory (a key prefix).
|
|
29
|
+
- Added: a required rule takes `accept`, up to 10 shorter wordings that also count as the rule
|
|
30
|
+
being there. MM020 now ignores case as well as spacing. Before, a rule written in the repo's
|
|
31
|
+
own words was reported as missing.
|
|
32
|
+
|
|
33
|
+
Index fixes on a memory folder (`apply`).
|
|
34
|
+
|
|
35
|
+
- Fixed: a list line whose hook is too long is cut at the last clause end (a full stop, `;`,
|
|
36
|
+
`,` or `:`), never mid-phrase. A cut at a word boundary could end on "never force-push main,
|
|
37
|
+
merge" and read as a different rule. With no clause end in reach, the line stays whole.
|
|
38
|
+
- Changed: on a first sort, `apply` also plans the fix-only version and keeps whichever leaves
|
|
39
|
+
the smaller always-loaded part. Before, a sort that saved a few tokens could win over index
|
|
40
|
+
fixes that saved more. The verdict now says "would save only N tokens a turn, less than this
|
|
41
|
+
plan" when that happens.
|
|
42
|
+
- Changed: `init`'s "best case" line now cites the Session Cost Test of this release, on a
|
|
43
|
+
test memory in the layout Claude Code writes: whole sessions 37.7% less at API rates over 3
|
|
44
|
+
sessions, not one run of an older build (24.0%). The vendored results ledger carries the run.
|
|
45
|
+
- The measured memory is not affected: on the results fixture and the example project, `apply`
|
|
46
|
+
writes byte-identical files before and after this change.
|
|
47
|
+
- Fixed: the npm description claimed "22% on Codex", a figure with no measured run behind it,
|
|
48
|
+
and gave 31% without its label. It now gives the 1.6.0 figure the README gives. The `init` line says
|
|
49
|
+
"Claude Code" and "at API rates". The README gives the dollars as two sessions a side.
|
|
50
|
+
|
|
51
|
+
## 1.5.0 - 2026-11-09
|
|
52
|
+
|
|
53
|
+
The Codex release. 1.4.3 was merged but never published; everything it held is listed after the
|
|
54
|
+
1.5.0 lines below, so npm goes 1.4.2 -> 1.5.0.
|
|
55
|
+
|
|
56
|
+
- Fixed (Codex): `undo` plans the chain from the host the manifest records. With minnimemory
|
|
57
|
+
registered in both Claude Code and Codex, a plain `undo` detected Claude Code and restored only
|
|
58
|
+
the start folder, leaving the user `AGENTS.md` and the git root's file compiled.
|
|
59
|
+
- Changed (Codex): the server instructions tell the agent to use the four tools, not the shell
|
|
60
|
+
CLI, and to report `doctor`'s findings instead of editing them away. A live Codex setup session
|
|
61
|
+
had run the CLI from the shell (38 to 45 calls instead of 4).
|
|
62
|
+
- Fixed (Codex): the CLI `undo` names every folder it restored. Before, a chain undo printed
|
|
63
|
+
"restored 1 file(s) in <start folder>" and counted only that folder's deletes, though it had
|
|
64
|
+
also restored the user `AGENTS.md` and the git root's file.
|
|
65
|
+
- Changed: one host adapter per host (`src/workspace/hosts/`); no host-name check outside
|
|
66
|
+
`host.ts` and `hosts/`. No behavior change on Claude Code.
|
|
67
|
+
- Changed (Codex): the size gate. A first compile of an `AGENTS.md` that Codex loads whole
|
|
68
|
+
(under its `project_doc_max_bytes` cap; the user file when it fits inside the cap) is left as
|
|
69
|
+
it is, and the plan says why: splitting a file that loads whole cost recall in every measured
|
|
70
|
+
case. Past the cap the compile runs as before; `--force` still applies it. Claude Code is
|
|
71
|
+
unchanged.
|
|
72
|
+
|
|
73
|
+
### From 1.4.3 (never published)
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
- Fixed: a rule stays in AlwaysOnMemory when its section ends in status subsections
|
|
77
|
+
(`### Current state`, `### Open items`, `### Session log`, a changelog). Before, the strict
|
|
78
|
+
volatility test read the whole section as volatile and routed the rule out with its history,
|
|
79
|
+
so a rule like "Ask Before Deleting" was no longer loaded; on Codex an agent then dropped a
|
|
80
|
+
table without asking. The section is now split: the rule stays, and only the status tail goes
|
|
81
|
+
to `__history` as one "(continued)" piece, verbatim and in order. A `**How to apply:**` line
|
|
82
|
+
under a section, the form Claude Code's memory writes, now marks it as a rule. Every host.
|
|
83
|
+
- Fixed: when the memory hook ranks several targets (the start folder, the chain root, the user
|
|
84
|
+
file), the one whose best section covers more of the prompt wins, not the first that covers it
|
|
85
|
+
at all. A `__history` piece ranks by its own headings instead of last for its file name.
|
|
86
|
+
- Changed: filler words such as "whether", "exactly" and "caused" no longer count as triggers
|
|
87
|
+
in an OnDemandMemory list. The ranker's stopwords are unchanged.
|
|
88
|
+
- Added (Codex): beside the placed section, the memory hook may place one short companion (at
|
|
89
|
+
most 200 tokens) when another section covers the prompt as well, plus a closely tied runner-up,
|
|
90
|
+
a repeat's best lines once per session, and a linked line, each with its own small cap. Claude
|
|
91
|
+
Code output is unchanged.
|
|
92
|
+
- Changed (Codex): a project `AGENTS.md`'s OnDemandMemory list names the folder its relative
|
|
93
|
+
paths start from; a prompt of more than 8 distinct terms needs 4 of them in a section to place
|
|
94
|
+
it, and an always-on match no longer silences the best on-demand section.
|
|
95
|
+
- Fixed (Codex): `init`'s report rule asks for one entry per `# AGENTS.md instructions` header,
|
|
96
|
+
`user` for a header with no folder and `files: []` when there is none, and `init`'s tool
|
|
97
|
+
description on Codex says so. Before, a lone user block was reported as `.` and an agent
|
|
98
|
+
with no project file sent nothing.
|
|
99
|
+
- Added (Codex): the memory hook tells the agent once per session to wait on a running test or
|
|
100
|
+
build with one long poll instead of many short ones. It goes out whatever the memory's size, and
|
|
101
|
+
with no compile at all. Claude Code is unchanged: its commands block, so it does not poll.
|
|
102
|
+
- Changed (Codex): one `apply` now covers the whole chain a session loads: the user
|
|
103
|
+
`AGENTS.md`, the git root's and the start folder's, each with its own backups and manifest,
|
|
104
|
+
under one plan and one command; one `undo` in the start folder puts them all back. The map and
|
|
105
|
+
the cap total now walk from the git root, so a session in a subfolder counts the root's file.
|
|
106
|
+
Before, `apply` compiled only the start folder's file and left the other two as they were.
|
|
107
|
+
Over MCP, `apply` and `undo` list (and with `content: true` return) every file in the chain. A
|
|
108
|
+
plan that writes the Codex home says so up front: Codex's sandbox does not let commands write
|
|
109
|
+
there, so the agent asks to run the command with escalated permissions instead of failing.
|
|
110
|
+
`--budget` is the start folder's; every other file keeps its own, so the printed command
|
|
111
|
+
matches the plan it was printed for.
|
|
112
|
+
- Fixed: `init` over MCP reads `loaded` sent as a JSON string, the way agents often send it on
|
|
113
|
+
their first call. Before, the call was refused and the agent retried, up to four times in live
|
|
114
|
+
runs. A JSON array of paths is read as `files`, and on Claude Code a memory folder in it as the
|
|
115
|
+
memory folder.
|
|
116
|
+
- Fixed (Codex): Codex's memory v2 folder (`$CODEX_HOME/memories_v2/`, the default for a fresh
|
|
117
|
+
profile that turns Memories on since Codex 0.165.0) is listed and never compiled, the same as
|
|
118
|
+
`memories/`; `--memory-dir` on it is refused.
|
|
119
|
+
- Fixed: `install` run from the npx cache (`npx -y minnimemory install`) no longer registers
|
|
120
|
+
that copy. npm clears the cache on its own, and the server then showed "Connection closed"
|
|
121
|
+
while every hook failed with no message. It now writes nothing, exits 2 and prints the durable
|
|
122
|
+
route: `npm i -g minnimemory`, then `minnimemory install`. `uninstall` still runs from npx.
|
|
123
|
+
README, ONBOARDING and AGENTS.md lead with those two lines.
|
|
124
|
+
|
|
6
125
|
## 1.4.2 - 2026-10-29
|
|
7
126
|
|
|
8
127
|
- Changed: the memory hook places a section only on a strong match. A weaker match on a rare word
|
package/LICENSE
CHANGED
|
@@ -1,61 +1,202 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
202
|
+
|
package/README.md
CHANGED
|
@@ -1,5 +1,10 @@
|
|
|
1
1
|
# MinniMemoryMCP
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/minnimemory)
|
|
4
|
+
[](https://www.npmjs.com/package/minnimemory)
|
|
5
|
+
[](https://github.com/MinniAI-com/MinniMemoryMCP/actions/workflows/ci.yml)
|
|
6
|
+
[](LICENSE)
|
|
7
|
+
|
|
3
8
|
**Curated memory for AI agents, served over MCP.** Your AI coding agent re-reads its entire
|
|
4
9
|
project memory file on every turn, most of it irrelevant to the task in front of it, and an
|
|
5
10
|
edited character near the top of that file busts prompt caching for everything after it.
|
|
@@ -9,7 +14,14 @@ in Claude Code and in the terminal: `init`, `doctor`, `apply`, `undo`. Determini
|
|
|
9
14
|
offline: no model, no key, no network, and the MCP server never writes your memory files (its one
|
|
10
15
|
write is `init`'s record of where Claude Code loads from).
|
|
11
16
|
|
|
12
|
-
|
|
17
|
+
**Measured:** with 1.6.0, on our test memory in the layout Claude Code itself writes, with an
|
|
18
|
+
agent that can read and search, Claude Code sessions cost 37.7% less at API rates: $0.47 to $0.29
|
|
19
|
+
a session, averaged over three sessions of the same 30 questions (each session 34% to 40% less).
|
|
20
|
+
The answers held: a blind judge found 81 of 87 correct after and 80 before. The run is a row in
|
|
21
|
+
[`vendor/ledger/RESULTS.md`](vendor/ledger/RESULTS.md) (2026-11-15), with every earlier run.
|
|
22
|
+
Codex is not measured yet.
|
|
23
|
+
|
|
24
|
+
Open source under Apache-2.0, built by [Minni AI](https://minniai.com). Contributions are welcome: see [CONTRIBUTING.md](CONTRIBUTING.md). Docs: [minniai.com/minnimemorymcp/docs](https://minniai.com/minnimemorymcp/docs). Measured results: [minniai.com/evidence](https://minniai.com/evidence). AI agents: start at [minniai.com/agents.md](https://minniai.com/agents.md). Watch: [MinniMemoryMCP product demo](https://www.youtube.com/watch?v=8T3DyjLUfKk), [how it reduces your token usage](https://www.youtube.com/watch?v=tsRfwqOV9HY).
|
|
13
25
|
|
|
14
26
|
## Try it in the terminal first
|
|
15
27
|
|
|
@@ -32,7 +44,7 @@ $ npx -y minnimemory init .
|
|
|
32
44
|
...2 more findings...
|
|
33
45
|
|
|
34
46
|
always-loaded, files this plan rewrites: 897 -> 389 tokens (-56.6%)
|
|
35
|
-
best case: kept only on turns that open none of the moved files. Measured on another memory with an agent that can read and search
|
|
47
|
+
best case: kept only on turns that open none of the moved files. Measured with 1.6.0 on another memory, in the layout Claude Code writes, with an agent that can read and search: whole Claude Code sessions cost 37.7% less at API rates (3 sessions, ledger 2026-11-15).
|
|
36
48
|
verdict: compile. Every turn with no routed file open saves 508 tokens; a turn with every
|
|
37
49
|
routed file open (613 tokens) costs 105 more than today. It pays unless routed text is open
|
|
38
50
|
on nearly every turn.
|
|
@@ -90,10 +102,11 @@ made it; only when the tool cannot tell where it runs from does it print `npx -y
|
|
|
90
102
|
## Install for Claude Code
|
|
91
103
|
|
|
92
104
|
```bash
|
|
93
|
-
|
|
105
|
+
npm i -g minnimemory
|
|
106
|
+
minnimemory install
|
|
94
107
|
```
|
|
95
108
|
|
|
96
|
-
|
|
109
|
+
The first line installs the package once; the second registers the MCP server for every project on this machine (runs `claude mcp add
|
|
97
110
|
minnimemory -s user -- node "<path to minnimemory>/cli.js" mcp` and prints exactly that line: a
|
|
98
111
|
direct call to the installed copy, so Claude Code does not re-resolve the package through `npx`
|
|
99
112
|
on every launch), turns on two prompt hooks by default (the memory hook and the drift notice,
|
|
@@ -101,9 +114,10 @@ see below), and prints the next step. Restart Claude Code. Running it again is s
|
|
|
101
114
|
it is already registered. After upgrading the package, run it again: it repoints the server and
|
|
102
115
|
the hooks at the new copy.
|
|
103
116
|
|
|
104
|
-
The registration points at the copy `install` ran from
|
|
105
|
-
`
|
|
106
|
-
|
|
117
|
+
The registration points at the copy `install` ran from, so that copy has to stay. Run as
|
|
118
|
+
`npx -y minnimemory install`, it would be the npx cache, which npm clears on its own; the server
|
|
119
|
+
would then show "Connection closed" and every hook would fail with no message. So from the npx
|
|
120
|
+
cache `install` writes nothing and prints the two lines above.
|
|
107
121
|
|
|
108
122
|
### Or as a Claude Code plugin
|
|
109
123
|
|
|
@@ -115,8 +129,8 @@ The same release, the same server and the same hooks, installed and removed thro
|
|
|
115
129
|
with nothing written to your `settings.json` by hand. Needs Claude Code 2.1.275 or later for the
|
|
116
130
|
one-line form (older: `claude plugin marketplace add MinniAI-com/minnimemory-plugin`, then
|
|
117
131
|
`claude plugin install minnimemory@minniai`) and Node 18.3 or later on your PATH. Pick one
|
|
118
|
-
route: if `
|
|
119
|
-
|
|
132
|
+
route: if `minnimemory install` ran on this machine, run `minnimemory uninstall` first
|
|
133
|
+
(`npx -y minnimemory uninstall` for an older npx registration), or you get two servers and every hook twice. Updates come with
|
|
120
134
|
`claude plugin update minnimemory@minniai`, or turn on auto-update for the `minniai` marketplace
|
|
121
135
|
in `/plugin`; `claude plugin uninstall minnimemory@minniai` removes it. The plugin repo holds
|
|
122
136
|
generated files only, built from the release tag (`docs/DESIGN.md` 7.1).
|
|
@@ -125,11 +139,11 @@ Useful variants of `install`:
|
|
|
125
139
|
|
|
126
140
|
| you want | run |
|
|
127
141
|
|---|---|
|
|
128
|
-
| this repo only, not every project | `
|
|
129
|
-
| see the command without running it | `
|
|
130
|
-
| re-register over an existing entry | `
|
|
131
|
-
| skip the hooks | `
|
|
132
|
-
| remove the registration and the hooks it added | `
|
|
142
|
+
| this repo only, not every project | `minnimemory install --scope project` |
|
|
143
|
+
| see the command without running it | `minnimemory install --dry-run` |
|
|
144
|
+
| re-register over an existing entry | `minnimemory install --force` |
|
|
145
|
+
| skip the hooks | `minnimemory install --no-hook` |
|
|
146
|
+
| remove the registration and the hooks it added | `minnimemory install --remove` |
|
|
133
147
|
|
|
134
148
|
The memory hook (`UserPromptSubmit`, `minnimemory hook`) runs before every prompt and places the
|
|
135
149
|
one short section of memory the prompt needs into the turn, only when the always-loaded memory
|
|
@@ -157,11 +171,12 @@ after it is added. Nothing loads on demand, so a long `AGENTS.md` is paid in ful
|
|
|
157
171
|
and whatever sits past the cap never reaches the model. The same four verbs trim it the same way.
|
|
158
172
|
|
|
159
173
|
```
|
|
160
|
-
|
|
174
|
+
npm i -g minnimemory
|
|
175
|
+
minnimemory install --host codex
|
|
161
176
|
```
|
|
162
177
|
|
|
163
|
-
This runs `codex mcp add minnimemory --
|
|
164
|
-
idempotent) and adds the two `UserPromptSubmit` hooks to `~/.codex/hooks.json` (`--scope
|
|
178
|
+
This runs `codex mcp add minnimemory -- node "<path to minnimemory>/cli.js" mcp --host codex`
|
|
179
|
+
(printed, and idempotent) and adds the two `UserPromptSubmit` hooks to `~/.codex/hooks.json` (`--scope
|
|
165
180
|
project` writes `<repo>/.codex/hooks.json`; Codex has no local scope). Without the `codex`
|
|
166
181
|
binary it prints the `[mcp_servers.minnimemory]` block to paste into `~/.codex/config.toml`
|
|
167
182
|
and exits 2. Then open Codex and run `/hooks` once to trust the two minnimemory hooks. Do not
|
|
@@ -188,7 +203,11 @@ What is different on Codex: the map shows the chain (layer, file, bytes, loaded)
|
|
|
188
203
|
force (a file cut by the cap shows `PART: first N bytes`); `doctor` adds MM022 (a file past the cap) and MM023 (`AGENTS.override.md` shadowing an
|
|
189
204
|
`AGENTS.md`); `apply` compiles the `AGENTS.md` Codex reads (the override file when present),
|
|
190
205
|
puts routed pieces in `OnDemandMemory/` beside it when the repo has no `.claude/` folder, and
|
|
191
|
-
refuses a plan whose compiled file would still be over the cap.
|
|
206
|
+
refuses a plan whose compiled file would still be over the cap. A file that already fits under
|
|
207
|
+
the cap, and so loads whole, is left as it is: splitting it cost recall on Codex (`--force`
|
|
208
|
+
compiles it anyway). Started in a subfolder, one
|
|
209
|
+
`apply` writes every file the session loads: your user `AGENTS.md`, the git root's and the
|
|
210
|
+
subfolder's, each with its own backups, and one `undo` there puts them all back. The discovery record lives
|
|
192
211
|
under `$CODEX_HOME/minnimemory/`. Nested `AGENTS.md` files below the root are listed with their
|
|
193
212
|
size and not compiled. If your project has no `AGENTS.md` of its own, `init` works on your user
|
|
194
213
|
file (`$CODEX_HOME/AGENTS.md`, which Codex loads in every project) and says so; `doctor`, `apply`
|
|
@@ -444,7 +463,7 @@ undo, then apply" as the fix.
|
|
|
444
463
|
| `--ci` | terse output, no colour |
|
|
445
464
|
| `--fail-on <sev>` | exit 1 at this severity or above: `low`, `med`, `high` (default `high`) |
|
|
446
465
|
| `--budget <n>` | always-loaded token budget for MM001 (default: the budget the workspace was compiled at, else 60% of the host file, at least 2000) |
|
|
447
|
-
| `--policy <file>` | a team's rule pack (`policy.json`): MM020 reports a required line missing from the always-loaded memory, MM021 banned text in any memory file; its `always_on_tokens` is the MM001 budget when `--budget` is not given. Without it, neither rule runs |
|
|
466
|
+
| `--policy <file>` | a team's rule pack (`policy.json`): MM020 reports a required line missing from the always-loaded memory, MM021 banned text in any memory file, where memory says to do it (a line that forbids it is not a finding unless the entry is `strict`); its `always_on_tokens` is the MM001 budget when `--budget` is not given. Without it, neither rule runs |
|
|
448
467
|
| `--only <ids>` | run only these rules, comma separated |
|
|
449
468
|
| `--ignore <ids>` | skip these rules, comma separated |
|
|
450
469
|
| `--rules` | list the rule set and exit |
|
|
@@ -511,7 +530,7 @@ keys, `map` (each load group, and each file's path, tokens and owner), `doctor`
|
|
|
511
530
|
`doctor` returns the last two. Every reply's data block carries a code drawn for that reply in
|
|
512
531
|
its open and close lines, so no line of memory text can end it; a memory line that looks like
|
|
513
532
|
the marker is also shown with "(quoted)" in the text form, and the JSON form keeps it exact. Register it with your agent rather than
|
|
514
|
-
running it by hand: `
|
|
533
|
+
running it by hand: `minnimemory install` above (a direct `node "<path>/cli.js" mcp`
|
|
515
534
|
registration), or by hand with `claude mcp add minnimemory -- npx -y minnimemory mcp`.
|
|
516
535
|
|
|
517
536
|
### `minnimemory install`
|
|
@@ -583,7 +602,7 @@ graded as good (Minni-AI run `2026-10-11-211152`).
|
|
|
583
602
|
|
|
584
603
|
A second `UserPromptSubmit` hook: reads the same stdin JSON, checks a compiled workspace for
|
|
585
604
|
drift (`doctor` rule MM010), and prints a one-line notice only when something changed since the
|
|
586
|
-
last `apply`, once per distinct change. `
|
|
605
|
+
last `apply`, once per distinct change. `minnimemory install` registers it for you by
|
|
587
606
|
default; `--no-hook` skips it.
|
|
588
607
|
|
|
589
608
|
### `minnimemory bench [path]`
|
|
@@ -610,8 +629,8 @@ The MCP server's own always-loaded cost, measured (not assumed), approx-v2 token
|
|
|
610
629
|
|
|
611
630
|
| | tokens |
|
|
612
631
|
|---|---|
|
|
613
|
-
| basic profile tool schemas (`init`, `doctor`, `apply`, `undo`), read-only | 1,
|
|
614
|
-
| basic profile tool schemas, `--allow-write` (no effect on basic) | 1,
|
|
632
|
+
| basic profile tool schemas (`init`, `doctor`, `apply`, `undo`), read-only | 1,275 |
|
|
633
|
+
| basic profile tool schemas, `--allow-write` (no effect on basic) | 1,275 |
|
|
615
634
|
| server instructions text | 50 |
|
|
616
635
|
|
|
617
636
|
Measured against a real registered server over an in-memory MCP transport, not assumed. Claude
|
|
@@ -674,11 +693,11 @@ nothing there is exercised end to end.
|
|
|
674
693
|
|
|
675
694
|
## License
|
|
676
695
|
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
and it sends nothing off your machine. The short instruction lines it writes into your
|
|
682
|
-
files are yours to keep, edit, commit and publish with your repository. The
|
|
683
|
-
|
|
684
|
-
`
|
|
696
|
+
Open source under the Apache License, Version 2.0. Copyright 2026 MinniAI. You may use, change
|
|
697
|
+
and share the code, at work too, under the terms in the `LICENSE` file. The source is at
|
|
698
|
+
[github.com/MinniAI-com/MinniMemoryMCP](https://github.com/MinniAI-com/MinniMemoryMCP); issues and pull requests are welcome, and
|
|
699
|
+
`CONTRIBUTING.md` there says how. The files the tool reads and writes on your machine stay
|
|
700
|
+
yours, and it sends nothing off your machine. The short instruction lines it writes into your
|
|
701
|
+
memory files are yours to keep, edit, commit and publish with your repository. The Minni AI and
|
|
702
|
+
MinniMemory names and logos are not covered by the licence (`TRADEMARKS.md`). The bundled
|
|
703
|
+
open-source components keep their own licences (`THIRD_PARTY_NOTICES.md` in the plugin).
|