@vheins/local-memory-mcp 0.1.40 → 0.1.41
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 +59 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,24 +17,72 @@ Built with a **Local-First** philosophy, this service stores architectural decis
|
|
|
17
17
|
- 📉 **Automatic Memory Decay:** Automatically archives obsolete memories to keep the context clean and relevant.
|
|
18
18
|
- 📊 **Glassy Dashboard:** Visualize memories, usage statistics, and audit interaction logs through a modern web interface.
|
|
19
19
|
|
|
20
|
-
##
|
|
20
|
+
## 🔌 MCP Usage & Configuration
|
|
21
21
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
22
|
+
Add this service to your AI Agent (Claude Desktop, Cursor, Windsurf, etc.) using one of the methods below.
|
|
23
|
+
|
|
24
|
+
> 💡 **Recommendation:** If your MCP runs frequently (agents, CI, automation), avoid `npx` and use a global or local install instead. It reduces unnecessary NPM downloads and speeds up Agent startup.
|
|
25
|
+
|
|
26
|
+
### 🚀 Quick Start (Zero Setup)
|
|
27
|
+
Best for **first-time users** or **quick testing**. This uses `npx` to run the server without any permanent setup.
|
|
28
|
+
|
|
29
|
+
```json
|
|
30
|
+
"local-memory": {
|
|
31
|
+
"command": "npx",
|
|
32
|
+
"args": ["-y", "@vheins/local-memory-mcp"],
|
|
33
|
+
"type": "stdio"
|
|
34
|
+
}
|
|
25
35
|
```
|
|
36
|
+
* **Uses `npx`**: Automatically handles the execution.
|
|
37
|
+
* **Tradeoff**: May re-download the package in some environments and is not optimal for frequent execution.
|
|
38
|
+
|
|
39
|
+
### ⚡ Recommended for Production / Frequent Usage
|
|
40
|
+
This method ensures the fastest startup times and maximum reliability for daily use.
|
|
26
41
|
|
|
27
|
-
|
|
28
|
-
|
|
42
|
+
1. **Install globally:**
|
|
43
|
+
```bash
|
|
44
|
+
npm install -g @vheins/local-memory-mcp
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
2. **Add to your configuration:**
|
|
48
|
+
```json
|
|
49
|
+
"local-memory": {
|
|
50
|
+
"command": "local-memory-mcp",
|
|
51
|
+
"type": "stdio"
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
* **Faster startup**: No network checks required on every start.
|
|
55
|
+
* **No repeated downloads**: Saves bandwidth and avoids NPM registry dependency.
|
|
56
|
+
* **Better for automation**: More stable for heavy-duty Agent workflows.
|
|
57
|
+
|
|
58
|
+
### 🧠 How It Works (Important Insight)
|
|
59
|
+
* **npx usage**: When you use `npx`, it often performs a network request to check for the latest version or re-downloads the package if it's not in the cache. Since MCP clients start and stop tools frequently, this can lead to hundreds of unnecessary downloads.
|
|
60
|
+
* **Installed binary**: By installing the package, you keep a permanent copy on your disk. The Agent reuses this local version instantly, providing a much smoother experience.
|
|
61
|
+
|
|
62
|
+
## 📊 Glassy Dashboard
|
|
63
|
+
|
|
64
|
+
Visualize and manage your Agent's memory through a modern web interface.
|
|
65
|
+
|
|
66
|
+
### How to Run
|
|
67
|
+
```bash
|
|
68
|
+
local-memory-mcp dashboard
|
|
69
|
+
```
|
|
70
|
+
*If not installed globally, use:* `npx @vheins/local-memory-mcp dashboard`
|
|
29
71
|
|
|
72
|
+
### Auto-launch in VS Code
|
|
73
|
+
Add this to your `.vscode/tasks.json` to have the dashboard start automatically:
|
|
30
74
|
```json
|
|
31
75
|
{
|
|
32
|
-
"
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
"
|
|
76
|
+
"version": "2.0.0",
|
|
77
|
+
"tasks": [
|
|
78
|
+
{
|
|
79
|
+
"label": "Launch Memory Dashboard",
|
|
80
|
+
"type": "shell",
|
|
81
|
+
"command": "npx -y @vheins/local-memory-mcp dashboard",
|
|
82
|
+
"isBackground": true,
|
|
83
|
+
"runOptions": { "runOn": "folderOpen" }
|
|
36
84
|
}
|
|
37
|
-
|
|
85
|
+
]
|
|
38
86
|
}
|
|
39
87
|
```
|
|
40
88
|
|