musememory 1.10.0 → 1.11.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 +47 -10
- package/dist/index.js +1907 -183
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|

|
|
14
14
|

|
|
15
15
|
|
|
16
|
-

|
|
17
17
|

|
|
18
18
|

|
|
19
19
|

|
|
@@ -24,8 +24,22 @@
|
|
|
24
24
|
|
|
25
25
|
---
|
|
26
26
|
|
|
27
|
+
## 🚀 What's New in v1.11.0 (Cognitive Engine Evolution & Hardening)
|
|
28
|
+
|
|
29
|
+
- **📜 Provenance & Source Ledger (`.memory/sources.json` / `memory source`)**: Records all external documentation, research papers, RFCs, and authoritative URLs with retrieval timestamps, authors, and classification tags.
|
|
30
|
+
- **🔍 Evidence-Grounded Claim Ledger (`.memory/claims.json` / `memory claim`)**: Connects atomic memories to verifiable claims tagged with strict confidence ratings: `[RAW]` (locally verified), `[FETCH]` (authoritative URL), `[SEARCH]` (search-synthesized), and `[INFER]` (agent deduction).
|
|
31
|
+
- **⚡ Deterministic Tiered Retrieval Engine (`--tier 0|1|2`)**: Bounded 3-tier retrieval prevents context stuffing: **Tier 0 (Manifest)** index (~50 tokens), **Tier 1 (Routing Set)** (~300 tokens), and **Tier 2 (Bounded Bodies)** fitted greedily into the knapsack token budget.
|
|
32
|
+
- **🧊 Frozen Execution Snapshots (`memory freeze`)**: Captures immutable run state (`.memory/runs/<run-id>/snapshot.json`) combining task specs, workspace file inventory, git SHA, active constraints, and SHA-256 memory hashes for deterministic regression replay.
|
|
33
|
+
- **📝 Native Structured Prompt Registry (`memory prompt`)**: Reusable structured prompt templates with live memory context injection (includes built-in `morning-standup`, `drift-audit`, `pre-publish-audit`, `sprint-compounding`).
|
|
34
|
+
- **⏳ Multi-Scale Temporal Compounding (`memory rollup`)**: Aggregates atomic session memories into weekly (`YYYY-Www.md`), monthly (`YYYY-MM.md`), and quarterly (`YYYY-QN.md`) synthesis wiki pages, and compiles the `.memory/HOT.md` instant working memory cache.
|
|
35
|
+
- **🔄 Gauntlet Iteration Ledger & Plateau Detector (`memory loop`)**: Multi-agent improvement loop ledger (`.memory/iterations.jsonl`) that detects plateaus and regression signals to halt runaway token consumption.
|
|
36
|
+
- **🛡️ Strict Integrity & Health Gate (`memory verify --strict`)**: Zero-tolerance audit verifying zero secret credentials, referential link integrity, wikilink resolution, orphaned candidate retention, and claim-to-source completeness.
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
27
40
|
## 📑 Table of Contents
|
|
28
41
|
|
|
42
|
+
- [🚀 What's New in v1.11.0](#-whats-new-in-v1110-cognitive-engine-evolution--hardening)
|
|
29
43
|
- [💡 What is Muse Memory? (TL;DR)](#-what-is-muse-memory-tldr)
|
|
30
44
|
- [✨ Key Feature Highlights](#-key-feature-highlights)
|
|
31
45
|
- [⚡ Quick Start & Installation](#-quick-start--installation)
|
|
@@ -368,13 +382,13 @@ Navigate to `http://localhost:2222` to access:
|
|
|
368
382
|
## 📖 Deep Technical References & Documentation
|
|
369
383
|
|
|
370
384
|
<details>
|
|
371
|
-
<summary><b>🔌 Complete MCP Tool Reference (
|
|
385
|
+
<summary><b>🔌 Complete MCP Tool Reference (40 Tools)</b> — <i>Click to expand</i></summary>
|
|
372
386
|
|
|
373
387
|
When registered as an MCP server, `musememory` exposes the following native tools:
|
|
374
388
|
|
|
375
389
|
| MCP Tool | Execution Phase | Description |
|
|
376
390
|
| :--- | :--- | :--- |
|
|
377
|
-
| `get_context` | **Session Start** | Fetches Top-$K$ ranked memories, `USER.md` profile,
|
|
391
|
+
| `get_context` | **Session Start** | Fetches Top-$K$ ranked memories, `USER.md` profile, active `CURRENT.md` constraints, and supports `--tier 0|1|2`. |
|
|
378
392
|
| `search` | **Investigation** | Searches memory units with query, token budget, project, type, and verification filters. |
|
|
379
393
|
| `memory_current` | **Constraints** | Reads or appends active project working constraints (`CURRENT.md`). |
|
|
380
394
|
| `memory_get_user_profile` | **Context Loading** | Reads active `USER.md` persona and communication preferences. |
|
|
@@ -386,6 +400,13 @@ When registered as an MCP server, `musememory` exposes the following native tool
|
|
|
386
400
|
| `memory_mark_stale` | **Deprecation** | Flags decaying knowledge with deprecation rationale. |
|
|
387
401
|
| `memory_reject` | **Hypothesis Refutation** | Marks invalidated hypotheses as rejected. |
|
|
388
402
|
| `memory_delete` | **Purge** | Permanently deletes an entry and records audit ledger log. |
|
|
403
|
+
| `memory_source_add` / `list` | **Provenance** | Records external docs/RFCs/URLs into `.memory/sources.json` and queries sources. |
|
|
404
|
+
| `memory_claim_record` / `list` | **Claim Ledger** | Records evidence-backed claims tagged with `[RAW]`, `[FETCH]`, `[SEARCH]`, `[INFER]`. |
|
|
405
|
+
| `memory_freeze_run` / `list` | **Execution Snapshots** | Freezes immutable task snapshots with file inventory and SHA-256 memory hashes. |
|
|
406
|
+
| `memory_prompt_list` / `get` / `run` | **Prompt Templates** | Manages and executes native structured prompt templates with live context injection. |
|
|
407
|
+
| `memory_rollup` | **Temporal Compounding** | Aggregates atomic memories into weekly, monthly, and quarterly rollups and updates `HOT.md`. |
|
|
408
|
+
| `memory_loop_record` / `status` | **Gauntlet Loops** | Multi-agent iteration ledger and plateau/regression detector (`.memory/iterations.jsonl`). |
|
|
409
|
+
| `memory_verify_strict` | **Integrity Gate** | Zero-tolerance audit verifying secrets, referential links, wikilinks, claims, and candidates. |
|
|
389
410
|
| `memory_tree_search` | **Tree Retrieval** | Hierarchical reasoning search across partitioned memory shards. |
|
|
390
411
|
| `memory_wiki_compile` | **Wiki Compiler** | Compiles confirmed memories into Obsidian-compatible Markdown pages. |
|
|
391
412
|
| `memory_wiki_search` / `get` | **Wiki Reading** | Searches and reads compiled concept and entity wiki pages. |
|
|
@@ -410,7 +431,7 @@ When registered as an MCP server, `musememory` exposes the following native tool
|
|
|
410
431
|
</details>
|
|
411
432
|
|
|
412
433
|
<details>
|
|
413
|
-
<summary><b>💻 Full CLI Command Matrix (
|
|
434
|
+
<summary><b>💻 Full CLI Command Matrix (41 Commands)</b> — <i>Click to expand</i></summary>
|
|
414
435
|
|
|
415
436
|
```bash
|
|
416
437
|
memory <command> [arguments] [flags] # alias: musememory
|
|
@@ -428,7 +449,7 @@ memory <command> [arguments] [flags] # alias: musememory
|
|
|
428
449
|
| `detect` | *(none)* | Scan workstation and local workspace for 29 external memory systems. |
|
|
429
450
|
| `migrate` | `[--provider P] [--all] [--dry-run] [--overwrite]` | Migrate memories into Muse Memory preserving active/archived state. |
|
|
430
451
|
| `ui` | `[--port N] [--global]` | Launch 6-view Cognitive Studio dashboard (default port: `2222`). |
|
|
431
|
-
| `context` | `[query] [--token-budget N] [--limit N]` | Retrieve Top-$K$ ranked active context for prompt injection. |
|
|
452
|
+
| `context` | `[query] [--token-budget N] [--limit N] [--tier 0\|1\|2]` | Retrieve Top-$K$ ranked active context for prompt injection. |
|
|
432
453
|
| `search` | `<query> [--limit N] [--token-budget N] [--type T]` | Ranked multi-factor token search with score breakdown. |
|
|
433
454
|
| `search-transcript` | `<query> [file.jsonl] [--window N]` | Full-text search past transcripts with dialogue context windows. |
|
|
434
455
|
| `learn` / `sync-chats` | `[--confirm] [--force] [--max N]` | **Universal auto-learner**: auto-discovers and distills memories from all agent chats across host machine. |
|
|
@@ -441,6 +462,13 @@ memory <command> [arguments] [flags] # alias: musememory
|
|
|
441
462
|
| `mark-stale` | `<id> [--reason <text>]` | Mark an entry stale with deprecation rationale. |
|
|
442
463
|
| `reject` | `<id> [--global]` | Mark an entry rejected. |
|
|
443
464
|
| `delete` | `<id> [--reason <text>]` | Permanently delete a memory entry and record audit event. |
|
|
465
|
+
| `source` | `add\|list\|show <url> [--title T] [--type T]` | Manage external documentation and URLs in provenance Source Ledger (`.memory/sources.json`). |
|
|
466
|
+
| `claim` | `record\|list\|show <text> [--confidence RAW\|FETCH\|SEARCH\|INFER]` | Record and query verifiable claims connected to sources (`.memory/claims.json`). |
|
|
467
|
+
| `freeze` | `--task <task.md\|text> [--run-id R]` | Capture immutable execution snapshot with file inventory and SHA-256 memory hashes. |
|
|
468
|
+
| `prompt` | `list\|show\|run <name> [--args k=v,...]` | Manage and run structured prompt templates with live context injection. |
|
|
469
|
+
| `rollup` | `--period week\|month\|quarter [--date YYYY-MM-DD]` | Multi-scale temporal compounding and `.memory/HOT.md` working memory cache compiler. |
|
|
470
|
+
| `loop` | `record\|status\|clear` | Multi-agent Gauntlet iteration ledger and plateau/regression detector. |
|
|
471
|
+
| `verify` | `<id> [--timeout S] [--strict]` | Execute a fix entry's test command or run full strict integrity gate. |
|
|
444
472
|
| `audit` | `[--operation OP] [--entry-id ID] [--limit N]` | Query append-only operational audit trail (`.memory/audit.jsonl`). |
|
|
445
473
|
| `link` | `<id> --related <id1,id2>` | Synchronize bidirectional relation links between entries. |
|
|
446
474
|
| `export` / `import` | `[--out <file.json>]` / `<file.json>` | Export and import portable JSON memory snapshots. |
|
|
@@ -505,7 +533,7 @@ memory user set "- Prefers TypeScript, Bun, and ultra terse responses"
|
|
|
505
533
|
|
|
506
534
|
```bash
|
|
507
535
|
bun install
|
|
508
|
-
bun test #
|
|
536
|
+
bun test # 322 passed across 58 test files (1305 assertions)
|
|
509
537
|
bun run typecheck # 0 static type errors
|
|
510
538
|
bun run build # Clean bundled distribution build (dist/index.js)
|
|
511
539
|
```
|
|
@@ -517,13 +545,18 @@ bun run build # Clean bundled distribution build (dist/index.js)
|
|
|
517
545
|
<details>
|
|
518
546
|
<summary><b>🔮 Sprint & Roadmap Lifecycle (Requested ➔ Planned ➔ In Progress ➔ Done)</b> — <i>Click to expand</i></summary>
|
|
519
547
|
|
|
520
|
-
Muse Memory features are developed in structured sprints moving across 4 deterministic lifecycle phases. Every sprint is delivered via PR from `dev` to `main` with associated GitHub milestones. Live tracking: [GitHub Issues & Milestones](https://github.com/harshsinghmp/musememory/issues).
|
|
548
|
+
Muse Memory features are developed in structured sprints moving across 4 deterministic lifecycle phases following strict `vX.Y.Z` semantic versioning. Every sprint is delivered via PR from `dev` to `main` with associated GitHub milestones. Live tracking: [GitHub Issues & Milestones](https://github.com/harshsinghmp/musememory/issues).
|
|
521
549
|
|
|
522
550
|
```
|
|
523
551
|
[ 📋 Requested ] ──► [ 📅 Planned ] ──► [ ⚡ In Progress ] ──► [ ✅ Done ]
|
|
524
552
|
(Issues / PRs) (Sprint Backlog) (Active PR / Milestone) (Shipped to Main)
|
|
525
553
|
```
|
|
526
554
|
|
|
555
|
+
### 🏷️ Semantic Versioning Protocol (`vX.Y.Z`)
|
|
556
|
+
- **`X` (Major)**: Breaking architectural changes, core schema shifts, or protocol overhauls (`vX.0.0`).
|
|
557
|
+
- **`Y` (Feature)**: Substantive new agent capabilities, MCP tools, or CLI subcommands (`vX.Y.0`).
|
|
558
|
+
- **`Z` (Minor / Hotfix / Critical Fix)**: Bug remediations, security patches, performance, and urgent hotfixes (`vX.Y.Z`).
|
|
559
|
+
|
|
527
560
|
### 📋 Phase 1: Requested (Backlog)
|
|
528
561
|
*Incoming community proposals, agent adapters, and feature requests pending sprint triage:*
|
|
529
562
|
- [ ] Multi-Agent Consensus Verification Protocol (cross-agent memory agreement)
|
|
@@ -532,9 +565,13 @@ Muse Memory features are developed in structured sprints moving across 4 determi
|
|
|
532
565
|
|
|
533
566
|
### 📅 Phase 2: Planned
|
|
534
567
|
*Confirmed high-leverage features scheduled for upcoming sprints:*
|
|
535
|
-
- [ ]
|
|
536
|
-
- [ ]
|
|
537
|
-
- [ ]
|
|
568
|
+
- [ ] **Tiered Retrieval Engine**: Deterministic Tier 0 (manifest), Tier 1 (invariants), Tier 2 (bounded bodies) knapsack retrieval
|
|
569
|
+
- [ ] **Provenance & Claim Ledgers**: Direct memory citations with `[RAW]`, `[FETCH]`, `[SEARCH]`, and `[INFER]` confidence tagging
|
|
570
|
+
- [ ] **Frozen Context Snapshots**: Immutable SHA-256 state tracking for reproducible agent execution
|
|
571
|
+
- [ ] **Native Prompt Registry**: Declarative prompt library & runner (`.memory/prompts/*.md`, `memory prompt run`)
|
|
572
|
+
- [ ] **Temporal Compounding**: Multi-scale Day $\to$ Week $\to$ Quarter wiki rollups & `.memory/HOT.md` cache
|
|
573
|
+
- [ ] **Gauntlet Iteration Ledger**: Multi-turn improvement loop tracking and plateau detection
|
|
574
|
+
- [ ] **Strict Health Gate**: Comprehensive `memory verify --strict` referential, link, and secret validator
|
|
538
575
|
|
|
539
576
|
### ⚡ Phase 3: In Progress (Active Sprint / PR)
|
|
540
577
|
*Currently under active development on dedicated feature branches:*
|