@memoryrelay/openclaw-plugin 0.1.0 → 0.1.1
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 +102 -10
- package/openclaw.plugin.json +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# OpenClaw Plugin for MemoryRelay
|
|
1
|
+
# OpenClaw Plugin for MemoryRelay AI
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/@memoryrelay/openclaw-plugin)
|
|
4
4
|
[](LICENSE)
|
|
@@ -40,10 +40,10 @@ Add to your `~/.openclaw/openclaw.json`:
|
|
|
40
40
|
{
|
|
41
41
|
"plugins": {
|
|
42
42
|
"slots": {
|
|
43
|
-
"memory": "
|
|
43
|
+
"memory": "plugin-memoryrelay-ai"
|
|
44
44
|
},
|
|
45
45
|
"entries": {
|
|
46
|
-
"
|
|
46
|
+
"plugin-memoryrelay-ai": {
|
|
47
47
|
"enabled": true,
|
|
48
48
|
"config": {
|
|
49
49
|
"apiKey": "mem_prod_...",
|
|
@@ -77,31 +77,81 @@ openclaw memoryrelay status
|
|
|
77
77
|
The plugin provides three tools your AI agent can use:
|
|
78
78
|
|
|
79
79
|
#### `memory_store`
|
|
80
|
-
|
|
80
|
+
|
|
81
|
+
Store a new memory with optional metadata.
|
|
82
|
+
|
|
83
|
+
> **Note**: The `agent_id` parameter is automatically injected from your config. You don't need to include it.
|
|
84
|
+
|
|
85
|
+
**Parameters:**
|
|
86
|
+
- `content` (string, required) - Memory content (1-50,000 characters)
|
|
87
|
+
- `metadata` (object, optional) - Key-value metadata (max 10KB when serialized)
|
|
88
|
+
|
|
89
|
+
**Example:**
|
|
81
90
|
```typescript
|
|
82
91
|
memory_store({
|
|
83
92
|
content: "User prefers concise bullet-point responses",
|
|
84
|
-
metadata: { category: "preferences" }
|
|
93
|
+
metadata: { category: "preferences", importance: "high" }
|
|
85
94
|
})
|
|
86
95
|
```
|
|
87
96
|
|
|
97
|
+
**Returns:** Memory object with `id`, `content`, `agent_id`, `metadata`, `created_at`, `updated_at`
|
|
98
|
+
|
|
99
|
+
**Rate Limit**: 30 requests per minute
|
|
100
|
+
|
|
88
101
|
#### `memory_recall`
|
|
89
|
-
|
|
102
|
+
|
|
103
|
+
Search memories using semantic similarity.
|
|
104
|
+
|
|
105
|
+
**Parameters:**
|
|
106
|
+
- `query` (string, required) - Natural language search query
|
|
107
|
+
- `limit` (number, optional, default: 10) - Maximum results (1-50)
|
|
108
|
+
- `threshold` (number, optional, default: 0.5) - Minimum similarity score (0-1)
|
|
109
|
+
|
|
110
|
+
**Example:**
|
|
90
111
|
```typescript
|
|
91
112
|
memory_recall({
|
|
92
|
-
query: "communication preferences",
|
|
93
|
-
limit: 5
|
|
113
|
+
query: "user communication preferences",
|
|
114
|
+
limit: 5,
|
|
115
|
+
threshold: 0.7
|
|
94
116
|
})
|
|
95
117
|
```
|
|
96
118
|
|
|
119
|
+
**Returns:** Array of search results with `memory` object and `score` (0-1):
|
|
120
|
+
```json
|
|
121
|
+
{
|
|
122
|
+
"results": [
|
|
123
|
+
{
|
|
124
|
+
"memory": {
|
|
125
|
+
"id": "550e8400-...",
|
|
126
|
+
"content": "User prefers concise bullet-point responses",
|
|
127
|
+
"metadata": { "category": "preferences" },
|
|
128
|
+
"created_at": 1707649200
|
|
129
|
+
},
|
|
130
|
+
"score": 0.89
|
|
131
|
+
}
|
|
132
|
+
]
|
|
133
|
+
}
|
|
134
|
+
```
|
|
135
|
+
|
|
97
136
|
#### `memory_forget`
|
|
98
|
-
|
|
137
|
+
|
|
138
|
+
Delete a memory by ID or search query.
|
|
139
|
+
|
|
140
|
+
**Parameters:**
|
|
141
|
+
- `memoryId` (string, optional) - Memory UUID to delete
|
|
142
|
+
- `query` (string, optional) - Search query (shows candidates if multiple matches)
|
|
143
|
+
|
|
144
|
+
**Examples:**
|
|
99
145
|
```typescript
|
|
146
|
+
// By ID
|
|
100
147
|
memory_forget({ memoryId: "550e8400-..." })
|
|
101
|
-
|
|
148
|
+
|
|
149
|
+
// By query (interactive if multiple matches)
|
|
102
150
|
memory_forget({ query: "outdated preference" })
|
|
103
151
|
```
|
|
104
152
|
|
|
153
|
+
**Returns:** Success confirmation
|
|
154
|
+
|
|
105
155
|
### CLI Commands
|
|
106
156
|
|
|
107
157
|
```bash
|
|
@@ -344,6 +394,48 @@ MIT © 2026 MemoryRelay
|
|
|
344
394
|
|
|
345
395
|
---
|
|
346
396
|
|
|
397
|
+
## Changelog
|
|
398
|
+
|
|
399
|
+
### v0.1.1 (2026-02-13)
|
|
400
|
+
|
|
401
|
+
**Breaking Changes:**
|
|
402
|
+
- Plugin ID changed: `memory-memoryrelay` → `plugin-memoryrelay-ai`
|
|
403
|
+
- Update your `openclaw.json` to use new ID in `plugins.slots.memory` and `plugins.entries`
|
|
404
|
+
|
|
405
|
+
**Documentation Improvements:**
|
|
406
|
+
- ✅ Added agent_id auto-injection documentation
|
|
407
|
+
- ✅ Added size limits (content 1-50K chars, metadata 10KB)
|
|
408
|
+
- ✅ Added rate limit info (30 req/min)
|
|
409
|
+
- ✅ Enhanced tool documentation with return formats
|
|
410
|
+
- ✅ Added response format examples for memory_recall
|
|
411
|
+
|
|
412
|
+
**Migration Guide:**
|
|
413
|
+
```json
|
|
414
|
+
{
|
|
415
|
+
"plugins": {
|
|
416
|
+
"slots": {
|
|
417
|
+
"memory": "plugin-memoryrelay-ai" // Changed
|
|
418
|
+
},
|
|
419
|
+
"entries": {
|
|
420
|
+
"plugin-memoryrelay-ai": { // Changed
|
|
421
|
+
"enabled": true,
|
|
422
|
+
"config": { ... }
|
|
423
|
+
}
|
|
424
|
+
}
|
|
425
|
+
}
|
|
426
|
+
}
|
|
427
|
+
```
|
|
428
|
+
|
|
429
|
+
### v0.1.0 (2026-02-12)
|
|
430
|
+
|
|
431
|
+
- Initial release
|
|
432
|
+
- Three tools: memory_store, memory_recall, memory_forget
|
|
433
|
+
- Auto-recall and auto-capture features
|
|
434
|
+
- CLI commands
|
|
435
|
+
- Production deployment on 3 agents
|
|
436
|
+
|
|
437
|
+
---
|
|
438
|
+
|
|
347
439
|
**Homepage**: https://memoryrelay.io
|
|
348
440
|
**API**: https://api.memoryrelay.net
|
|
349
441
|
**Source**: https://github.com/memoryrelay/openclaw-plugin
|
package/openclaw.plugin.json
CHANGED