@t0ken.ai/memoryx-openclaw-plugin 1.0.4 → 1.0.6

package/README.md

@@ -1,35 +1,128 @@
 # MemoryX OpenClaw Plugin
 
-Real-time memory capture and recall plugin for OpenClaw.
+Official MemoryX plugin for OpenClaw. Enables long-term memory for agents by recalling context before execution and saving conversations after each run.
 
 ## Features
 
-- **Conversation Buffer**: Automatically buffers conversations with token counting
+- **Recall**: `before_agent_start` → semantic search for relevant memories
+- **Add**: `message_received` + `assistant_response` → buffer and flush to MemoryX API
 - **Auto Registration**: Agents auto-register with machine fingerprint
-- **Memory Recall**: Semantic search for relevant memories
-- **Configurable API**: Custom API base URL support
+- **Conversation Buffer**: Smart buffering with token counting and round-based flushing
 
-## Installation
+## Install
+
+### Option A — NPM (Recommended)
+
+```bash
+openclaw plugins install @t0ken.ai/memoryx-openclaw-plugin
+openclaw gateway restart
+```
+
+Make sure it's enabled in `~/.openclaw/openclaw.json`:
+
+```json
+{
+  "plugins": {
+    "entries": {
+      "@t0ken.ai/memoryx-openclaw-plugin": { "enabled": true }
+    }
+  }
+}
+```
+
+### Option B — GitHub
 
 ```bash
-npm install @t0ken.ai/memoryx-openclaw-plugin
+openclaw plugins install github:t0ken-ai/MemoryX#plugins/memoryx-realtime-plugin
+openclaw gateway restart
+```
+
+### Option C — Local path
+
+Copy this folder into an OpenClaw plugin path (e.g. `~/.openclaw/extensions/`) or use `plugins.load.paths` to point at it.
+
+Example `~/.openclaw/openclaw.json`:
+
+```json
+{
+  "plugins": {
+    "entries": {
+      "memoryx-openclaw-plugin": { "enabled": true }
+    },
+    "load": { "paths": ["/path/to/memoryx-openclaw-plugin"] }
+  }
+}
 ```
 
+Restart the gateway after config changes.
+
 ## Configuration
 
+### Plugin Config
+
+In `plugins.entries.memoryx-openclaw-plugin.config`:
+
 ```json
 {
   "apiBaseUrl": "https://t0ken.ai/api"
 }
 ```
 
-## Usage
+For self-hosted MemoryX:
+
+```json
+{
+  "apiBaseUrl": "http://192.168.31.65:8000/api"
+}
+```
+
+### Environment Variables
+
+The plugin stores credentials locally in `~/.t0ken/memoryx.sqlite`.
+
+## How it Works
+
+### Recall (`before_agent_start`)
+
+- Builds a `/v1/memories/search` request using the current prompt
+- Injects relevant memories via `prependContext`:
+  ```
+  [相关记忆]
+  - [preference] User prefers dark mode
+  - [fact] User's timezone is UTC+8
+  [End of memories]
+  ```
+
+### Add (`message_received` + `assistant_response`)
+
+- Buffers messages with precise token counting (tiktoken)
+- Flushes to `/v1/conversations/flush` when:
+  - 2 conversation rounds completed (user + assistant = 1 round)
+  - 30 minutes timeout
+- Server extracts entities, facts, and preferences automatically
+
+### Auto Registration
+
+On first run, the plugin:
+1. Generates a machine fingerprint
+2. Calls `/agents/auto-register` to get API key
+3. Stores credentials locally for future sessions
+
+## Memory Categories
+
+Memories are categorized by the server:
+- **preference**: User preferences and settings
+- **fact**: Factual information about the user
+- **plan**: Future plans and goals
+- **experience**: Past experiences
+- **opinion**: User opinions and views
+
+## Notes
 
-The plugin automatically:
-1. Captures user and assistant messages
-2. Buffers conversations until threshold (2 rounds)
-3. Flushes to MemoryX API for memory extraction
-4. Recalls relevant memories before agent starts
+- Conversation buffer uses `cl100k_base` encoding (GPT-4 compatible)
+- Maximum 8000 tokens per message
+- Minimum 2 characters per message
+- Short messages like "ok", "thanks" are skipped
 
 ## License
 

package/dist/index.js

@@ -323,7 +323,7 @@ let plugin;
 export default {
     id: "@t0ken.ai/memoryx-openclaw-plugin",
     name: "MemoryX Real-time Plugin",
-    version: "1.0.4",
+    version: "1.0.6",
     description: "Real-time memory capture and recall for OpenClaw",
     register(api, pluginConfig) {
         api.logger.info("[MemoryX] Plugin registering...");

package/openclaw.plugin.json

@@ -1,16 +1,18 @@
 {
   "id": "@t0ken.ai/memoryx-openclaw-plugin",
   "name": "MemoryX Real-time Plugin",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Real-time memory capture and recall for OpenClaw",
-  "entry": "./dist/index.js",
   "kind": "memory",
+  "main": "./dist/index.js",
   "configSchema": {
     "type": "object",
     "properties": {
       "apiBaseUrl": {
-        "type": "string"
+        "type": "string",
+        "description": "MemoryX API base URL (default: https://t0ken.ai/api)"
       }
-    }
+    },
+    "additionalProperties": false
   }
 }

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@t0ken.ai/memoryx-openclaw-plugin",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "MemoryX real-time memory capture and recall plugin for OpenClaw",
   "type": "module",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "author": "MemoryX Team",
+  "license": "MIT",
+  "main": "./dist/index.js",
   "files": [
     "dist",
     "openclaw.plugin.json",
     "README.md"
   ],
   "scripts": {
-    "build": "tsc",
-    "prepare": "npm run build"
+    "build": "tsc"
   },
   "keywords": [
     "openclaw",
@@ -20,17 +20,13 @@
     "memory",
     "plugin"
   ],
-  "author": "MemoryX Team",
-  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/t0ken-ai/MemoryX.git",
     "directory": "plugins/memoryx-realtime-plugin"
   },
   "openclaw": {
-    "extensions": [
-      "./dist/index.js"
-    ]
+    "extensions": ["./dist/index.js"]
   },
   "devDependencies": {
     "@types/node": "^20.0.0",