@shodh/memory-mcp 0.1.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 +85 -0
- package/dist/index.js +5176 -0
- package/package.json +46 -0
package/README.md
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# Shodh-Memory MCP Server
|
|
2
|
+
|
|
3
|
+
Persistent AI memory with semantic search. Store observations, decisions, learnings, and recall them across sessions.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- **Semantic Search**: Find memories by meaning, not just keywords
|
|
8
|
+
- **Memory Types**: Categorize as Observation, Decision, Learning, Error, Pattern, etc.
|
|
9
|
+
- **Persistent**: Memories survive across sessions and restarts
|
|
10
|
+
- **Fast**: Sub-millisecond retrieval with vector indexing
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
### 1. Start the shodh-memory backend
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
# Download and run the server
|
|
18
|
+
cargo install shodh-memory
|
|
19
|
+
shodh-memory-server
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Or with Docker:
|
|
23
|
+
```bash
|
|
24
|
+
docker run -p 3030:3030 shodh/memory
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
### 2. Configure your MCP client
|
|
28
|
+
|
|
29
|
+
**For Claude Desktop** (`~/.claude/claude_desktop_config.json`):
|
|
30
|
+
```json
|
|
31
|
+
{
|
|
32
|
+
"mcpServers": {
|
|
33
|
+
"shodh-memory": {
|
|
34
|
+
"command": "npx",
|
|
35
|
+
"args": ["@shodh/memory-mcp"],
|
|
36
|
+
"env": {
|
|
37
|
+
"SHODH_API_URL": "http://127.0.0.1:3030"
|
|
38
|
+
}
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
**For Cursor/other MCP clients**: Similar configuration with the npx command.
|
|
45
|
+
|
|
46
|
+
## Tools
|
|
47
|
+
|
|
48
|
+
| Tool | Description |
|
|
49
|
+
|------|-------------|
|
|
50
|
+
| `remember` | Store a memory with optional type and tags |
|
|
51
|
+
| `recall` | Semantic search to find relevant memories |
|
|
52
|
+
| `list_memories` | List all stored memories |
|
|
53
|
+
| `forget` | Delete a specific memory by ID |
|
|
54
|
+
| `memory_stats` | Get statistics about stored memories |
|
|
55
|
+
|
|
56
|
+
## Usage Examples
|
|
57
|
+
|
|
58
|
+
```
|
|
59
|
+
"Remember that the user prefers Rust over Python for systems programming"
|
|
60
|
+
"Recall what I know about user's programming preferences"
|
|
61
|
+
"List my recent memories"
|
|
62
|
+
"Show memory stats"
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Environment Variables
|
|
66
|
+
|
|
67
|
+
| Variable | Default | Description |
|
|
68
|
+
|----------|---------|-------------|
|
|
69
|
+
| `SHODH_API_URL` | `http://127.0.0.1:3030` | Backend server URL |
|
|
70
|
+
| `SHODH_API_KEY` | (dev key) | API key for authentication |
|
|
71
|
+
| `SHODH_USER_ID` | `default` | User ID for memory isolation |
|
|
72
|
+
|
|
73
|
+
## Architecture
|
|
74
|
+
|
|
75
|
+
```
|
|
76
|
+
┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐
|
|
77
|
+
│ AI Client │────▶│ MCP Server │────▶│ Shodh Backend │
|
|
78
|
+
│ (Claude, etc.) │ │ (this package) │ │ (Rust server) │
|
|
79
|
+
└─────────────────┘ └─────────────────┘ └─────────────────┘
|
|
80
|
+
stdio REST API
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
## License
|
|
84
|
+
|
|
85
|
+
Apache-2.0
|