opencode-memoir 1.1.9 → 2.0.1

package/README.md

@@ -2,7 +2,7 @@
 
 OpenCode plugin for [Memoir](https://github.com/zhangfengcdt/memoir): git-versioned, taxonomy-structured memory for coding agents.
 
-The OpenCode counterpart to the Claude Code and Codex Memoir plugins. Derives a per-project store under `~/.memoir/<path-slug>`, resolves the `memoir` CLI with `uvx` fallback, and exposes commands/tools for status, recall, remember, and UI launch.
+Dynamically loads the `memoir-mcp` MCP server via `uvx` — no manual CLI installation needed.
 
 ## Install
 
@@ -18,25 +18,14 @@ Add the package name to your OpenCode config (`~/.config/opencode/opencode.jsonc
 
 OpenCode downloads and resolves the package from npm automatically; no manual install or `npm:` prefix needed. To pin a version, append it: `"opencode-memoir@1.0.0"`.
 
-The `memoir` CLI is resolved automatically with no separate install — see [Memoir CLI resolution](#memoir-cli-resolution).
-
 ## Quick start
 
 1. Install the plugin (see above)
-2. Run `/memoir:status` in any project to verify the store was created
-3. Start saving memories with `/memoir:remember` or let the agent auto-capture
+2. Start coding — the agent can use `memoir_recall`, `memoir_remember`, `memoir_get` MCP tools automatically
 
 ## Store configuration
 
-The plugin uses the same environment variable as the Claude Code plugin:
-
-| Source | Description |
-|---|---|
-| plugin option `store` | Highest-priority override when the plugin is loaded from `plugin[]` |
-| `MEMOIR_STORE` | Portable global/project override |
-| auto-derived path | `~/.memoir/<slug>`, where slug = git root (or resolved cwd) with `/` and `.` replaced by `-`; all worktrees share one store |
-
-Example when loading through `plugin[]`:
+The plugin delegates store path resolution to `memoir-mcp`. Override via `MEMOIR_STORE` env var or `store` plugin option:
 
 ```jsonc
 {
@@ -48,70 +37,35 @@ Example when loading through `plugin[]`:
 
 ## Environment variables
 
-All variables are optional. Capture and sanitization are on by default.
+All optional:
 
 | Variable | Effect |
 |---|---|
-| `MEMOIR_STORE` | Override the derived store path (see above). |
-| `MEMOIR_DEBUG=1` | Emit diagnostic logs to stderr (prefixed `[memoir]`). All internal errors are logged here instead of failing silently. Off by default. |
-| `MEMOIR_NO_CAPTURE=1` | Disable all capture — no metrics, no code-change tracking, no branch auto-match flush. Superset switch. |
-| `MEMOIR_NO_METRICS=1` | Disable per-tool metrics only (`metrics.turn.<branch>`). Code-change tracking still runs. |
-| `MEMOIR_NO_CODE_SUMMARY=1` | Disable code-change tracking only (`metrics.code.<branch>`). Metrics still run. |
-| `MEMOIR_SANITIZE_SECRETS=0` | Disable the secret-pattern guard on `memoir_remember`. Sanitization is **on** by default; set to `0` only if the guard produces false positives you understand. |
-
-Capture guards are checked at the collection point (`tool.execute.after`) and the flush point (`chat.message`), so setting them mid-session takes effect on the next turn.
-
-## Commands
-
-| Command | Description |
-|---|---|
-| `/memoir:status` | Show status for the current project store, including project git branch metadata |
-| `/memoir:ui` | Launch or reopen the Memoir web UI |
-| `/memoir:remember <memory>` | Ask the agent to save an explicit durable memory with a semantic path |
-| `/memoir:recall <topic>` | Ask the agent to list and use relevant stored memories |
-| `/memoir:onboard` | Populate or refresh the project onboarding snapshot |
-| `/memoir:unmerged` | List memoir branches that have diverged from `main` |
-
-## Tools
-
-| Tool | Description |
-|---|---|
-| `memoir_status` | Run the status helper |
-| `memoir_remember` | Save explicit content to one or more semantic paths; refuses secret-like content |
-| `memoir_recall` | List memory keys via `summarize` for relevance selection |
-| `memoir_get` | Fetch selected exact keys after `memoir_recall` |
+| `MEMOIR_STORE` | Override store path (passed to memoir-mcp as `--store`) |
+| `MEMOIR_DEBUG=1` | Emit diagnostic logs to stderr (prefixed `[memoir]`) |
+| `MEMOIR_AUTO_SAVE=1` | Auto-save session marker on dispose (default: disabled) |
+| `MEMOIR_REMINDER_INTERVAL=N` | Periodic save/recall reminder every N messages (default: 5, 0 to disable) |
 
 ## Hooks
 
-The plugin registers eight OpenCode hooks, mirroring the Claude Code plugin's lifecycle:
-
 | Hook | Purpose |
 |---|---|
-| `config` | Registers slash commands |
-| `command.execute.before` | Handles `/memoir:status`, `/memoir:ui`, `/memoir:unmerged` |
-| `shell.env` | Injects `MEMOIR_STORE` into shell env |
-| `event` | On `session.created`, fetches the taxonomy overview in the background |
-| `tool.execute.after` | Accumulates per-tool metrics + file edits for code change audit |
-| `chat.message` | Auto-matches memoir branch to git branch, flushes capture, runs recall gate |
-| `experimental.chat.system.transform` | Injects taxonomy context + recall instruction |
-| `dispose` | Flushes remaining data, prunes session state |
-
-See the [Memoir docs](https://zhangfengcdt.github.io/memoir/) for detailed hook behaviour.
+| `config` | Registers `memoir-mcp` as a dynamic MCP server; adds `/memoir:onboard` slash command |
+| `shell.env` | Injects `MEMOIR_STORE` into shell environment |
+| `chat.message` | Increments message counter; auto-matches memoir branch to current git branch |
+| `experimental.chat.system.transform` | Startup hint (once/session); periodic save/recall reminder |
+| `dispose` | Optionally saves session marker; clears all pending state |
 
-## Memoir CLI resolution
+## How it works
 
-1. `memoir` on `PATH`
-2. `uvx --from memoir-ai==<pin> memoir` — ephemeral, pinned
-3. `uv tool run --from memoir-ai==<pin> memoir` — pinned fallback
-
-Every command passes an explicit `-s <store>` to keep the project git and Memoir store separate.
+Instead of wrapping the `memoir` CLI and re-implementing tools in TypeScript, this plugin registers `memoir-mcp` as a dynamic MCP server. OpenCode starts the server via `uvx --from memoir-ai[mcp] memoir-mcp`, and all memoir tools (`memoir_recall`, `memoir_remember`, `memoir_get`, etc.) are available natively to the LLM.
 
 ## Development
 
 ### Prerequisites
 
 - Node.js >= 20
-- `memoir` CLI somewhere accessible, OR `uv` installed (the plugin falls back to `uvx`)
+- `uv` installed (for `uvx` to run memoir-mcp)
 
 ### Setup
 
@@ -125,28 +79,16 @@ npm test         # run the test suite
 
 | File | Responsibility |
 |---|---|
-| `src/store.ts` | CLI resolution + runner, git/worktree helpers, store-path derivation, branch management |
-| `src/capture.ts` | Edit tracking, per-tool metrics, `flushCapture` (read-merge-write of `metrics.*`) |
-| `src/recall-gate.ts` | Secret pattern + sanitization toggle, recall-gate trigger logic |
-| `src/index.ts` | Plugin wiring — tool definitions, hooks, command registration |
-| `src/debug.ts` | Shared debug logger |
-
-### Tests
-
-The suite runs with `tsx --test` (handles `.js` → `.ts` resolution under NodeNext).
-
-To debug hooks locally, run OpenCode with `MEMOIR_DEBUG=1` and watch stderr for `[memoir]` lines.
+| `src/index.ts` | Plugin entry: MCP registration + all hooks + dispose |
+| `src/store.ts` | Store path derivation, branch auto-match, `callMemoir` CLI helper |
+| `src/memory-saver.ts` | Per-session message counter for periodic reminders |
+| `src/debug.ts` | Conditional stderr logger (`MEMOIR_DEBUG=1`) |
 
 ## Publishing
 
 Releases are fully automated — no manual `npm version` or `npm publish`.
 
-1. Land changes on `main` via PR using [Conventional Commits](https://www.conventionalcommits.org/) (`feat:`, `fix:`, `chore:`, etc.). The commit type determines the version bump.
-2. On push to `main`, `.github/workflows/semantic.yaml` runs [semantic-release](https://semantic-release.gitbook.io/): it computes the next version, updates the changelog, commits `chore(release): x.y.z`, and pushes a matching `vx.y.z` git tag.
-3. The new tag triggers `.github/workflows/publish-npm.yaml`, which builds and runs `npm publish --provenance` to npm via [Trusted Publishing](https://docs.npmjs.com/trusted-publishers) (OIDC — no tokens stored).
-
-Published files are limited to `dist/` and `README.md` (see `files` in `package.json`); the `prepublishOnly` script runs `build` + `test` as a safety net.
-
-## License
+1. Land changes on `main` via PR using [Conventional Commits](https://www.conventionalcommits.org/) (`feat:`, `fix:`, etc.)
+2. On push to `main`, `.github/workflows/semantic.yaml` runs [semantic-release](https://semantic-release.gitbook.io/)
+3. The new tag triggers `.github/workflows/publish-npm.yaml`, which builds and runs `npm publish --provenance`
 
-Apache-2.0

package/dist/index.d.ts

@@ -1,10 +1,4 @@
 import type { PluginModule } from "@opencode-ai/plugin";
-/**
- * V1 plugin module format: OpenCode's loader recognizes `{ id, server }` and
- * ignores any other module exports. The legacy format (default-exported
- * function) made the loader treat EVERY export as a plugin and fail on
- * non-function exports ("Plugin export is not a function").
- */
 declare const plugin: PluginModule;
 export default plugin;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAU,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAwGhE;;;;;GAKG;AACH,QAAA,MAAM,MAAM,EAAE,YAGb,CAAC;AAEF,eAAe,MAAM,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAkB,YAAY,EAAE,MAAM,qBAAqB,CAAC;AA4IxE,QAAA,MAAM,MAAM,EAAE,YAGb,CAAC;AAEF,eAAe,MAAM,CAAC"}