engrm 0.4.38 → 0.4.39

package/opencode/README.md

@@ -0,0 +1,70 @@
+# Engrm OpenCode Support
+
+Engrm supports OpenCode in two layers:
+
+- Engrm as an MCP server in `opencode.json`
+- a lightweight local OpenCode plugin that improves continuity during compaction
+
+This keeps the OpenCode integration safe:
+
+- MCP stays responsible for durable memory, handoffs, chat recall, and resume tools
+- the plugin only adds OpenCode-native continuity behavior where hooks make sense
+
+## Install
+
+Run:
+
+```bash
+./opencode/install-or-update-opencode-plugin.sh
+```
+
+This will:
+
+- copy the local plugin to `~/.config/opencode/plugins/engrm.js`
+- add or update an `engrm` MCP server in `~/.config/opencode/opencode.json`
+
+## Config Shape
+
+The MCP entry written by the helper script matches:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "mcp": {
+    "engrm": {
+      "type": "local",
+      "command": ["engrm", "serve"],
+      "enabled": true,
+      "timeout": 5000
+    }
+  }
+}
+```
+
+An example file also lives at:
+
+- `opencode/opencode.example.json`
+
+## What The Plugin Does
+
+The first OpenCode plugin is intentionally conservative.
+
+- logs plugin initialization through OpenCode's app log
+- watches `session.created` and `session.compacted`
+- injects Engrm continuity guidance into `experimental.session.compacting`
+
+It does not try to replace Engrm MCP tools or perform undocumented runtime tricks.
+
+## Use With Engrm
+
+Inside OpenCode, the most useful Engrm tools remain:
+
+- `resume_thread`
+- `list_recall_items`
+- `load_recall_item`
+- `repair_recall`
+- `search_recall`
+- `save_observation`
+- `create_handoff`
+
+The plugin exists to make OpenCode compaction preserve that workflow better, not to fork it.

package/opencode/install-or-update-opencode-plugin.sh

@@ -0,0 +1,46 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+export ENGRM_OPENCODE_SCRIPT_DIR="$SCRIPT_DIR"
+
+python3 - <<'PY'
+from pathlib import Path
+import json
+import shutil
+import os
+
+root = Path(os.environ["ENGRM_OPENCODE_SCRIPT_DIR"]).resolve()
+repo = root.parent
+plugin_source = repo / "opencode" / "plugin" / "engrm-opencode.js"
+config_dir = Path.home() / ".config" / "opencode"
+plugins_dir = config_dir / "plugins"
+config_path = config_dir / "opencode.json"
+
+plugins_dir.mkdir(parents=True, exist_ok=True)
+shutil.copy2(plugin_source, plugins_dir / "engrm.js")
+
+if config_path.exists():
+    try:
+        config = json.loads(config_path.read_text())
+    except Exception:
+        config = {}
+else:
+    config = {}
+
+config.setdefault("$schema", "https://opencode.ai/config.json")
+mcp = config.setdefault("mcp", {})
+mcp["engrm"] = {
+    "type": "local",
+    "command": ["engrm", "serve"],
+    "enabled": True,
+    "timeout": 5000,
+}
+
+config_path.write_text(json.dumps(config, indent=2) + "\n")
+
+print(f"Installed plugin -> {plugins_dir / 'engrm.js'}")
+print(f"Updated config   -> {config_path}")
+PY
+
+echo "OpenCode Engrm integration install/update complete."

package/opencode/opencode.example.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://opencode.ai/config.json",
+  "mcp": {
+    "engrm": {
+      "type": "local",
+      "command": [
+        "engrm",
+        "serve"
+      ],
+      "enabled": true,
+      "timeout": 5000
+    }
+  }
+}

package/opencode/plugin/engrm-opencode.js

@@ -0,0 +1,61 @@
+export const EngrmPlugin = async ({ client, directory, worktree, project }) => {
+  const projectLabel = project?.name ?? directory ?? worktree ?? "unknown";
+
+  try {
+    await client.app.log({
+      body: {
+        service: "engrm-opencode",
+        level: "info",
+        message: "Engrm OpenCode plugin initialized",
+        extra: { project: projectLabel },
+      },
+    });
+  } catch {
+    // Best-effort only
+  }
+
+  return {
+    event: async ({ event }) => {
+      if (!event?.type) return;
+      if (event.type === "session.created" || event.type === "session.compacted") {
+        try {
+          await client.app.log({
+            body: {
+              service: "engrm-opencode",
+              level: "info",
+              message: `Observed OpenCode event: ${event.type}`,
+              extra: { project: projectLabel },
+            },
+          });
+        } catch {
+          // Best-effort only
+        }
+      }
+    },
+
+    "experimental.session.compacting": async (_input, output) => {
+      output.context.push(`
+## Engrm Continuity
+
+Before finalizing the compaction summary, preserve the active working thread using Engrm's continuity model.
+
+Prefer these Engrm tools when continuity is unclear:
+1. \`resume_thread\`
+2. \`list_recall_items\`
+3. \`load_recall_item\`
+4. \`repair_recall\`
+
+Carry forward:
+- the current task and status
+- the current thread in one sentence
+- the next actions
+- the hot files or touched files
+- the best exact recall key to reopen, if one is available
+
+Do not collapse the session into generic status language if a more specific current thread exists.
+      `.trim());
+    },
+  };
+};
+
+export default EngrmPlugin;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "engrm",
-  "version": "0.4.38",
-  "description": "Shared memory across devices, sessions, and agents, with thin MCP tools for durable capture and live continuity",
+  "version": "0.4.39",
+  "description": "Shared memory across devices, sessions, and agents, with thin MCP tools for durable capture, live continuity, and Hermes-ready remote MCP support",
   "mcpName": "io.github.dr12hes/engrm",
   "type": "module",
   "main": "dist/server.js",
@@ -10,6 +10,7 @@
   },
   "files": [
     "dist/",
+    "opencode/",
     "packs/",
     "LICENSE"
   ],
@@ -18,7 +19,9 @@
     "init": "bun run src/cli.ts init",
     "test": "bun test",
     "build": "bun run bin/build.mjs",
-    "prepublishOnly": "bun run build"
+    "check:openclaw-plugin": "node scripts/check-openclaw-plugin-contract.mjs",
+    "check:release": "bun run build && node scripts/check-public-docs.mjs && node scripts/check-openclaw-plugin-contract.mjs",
+    "prepublishOnly": "npm run check:release"
   },
   "engines": {
     "node": ">=18.0.0"
@@ -34,7 +37,10 @@
     "code-audit",
     "cross-device",
     "team-memory",
-    "developer-tools"
+    "developer-tools",
+    "hermes",
+    "streamable-http",
+    "remote-mcp"
   ],
   "dependencies": {
     "@anthropic-ai/claude-agent-sdk": "^0.2.74",