@vheins/local-memory-mcp 0.1.1 → 0.1.3
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 +136 -0
- package/package.json +6 -9
package/README.md
CHANGED
|
@@ -15,13 +15,149 @@ This project implements a local memory service using Node.js and SQLite with vec
|
|
|
15
15
|
- **MCP Protocol**: Full implementation of MCP resources, tools, and prompts
|
|
16
16
|
- **Web Dashboard**: Browser-based UI for visualizing and managing memories
|
|
17
17
|
|
|
18
|
+
## Quick Start (npx)
|
|
19
|
+
|
|
20
|
+
The easiest way to use this MCP server is via npx - no installation required:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npx @vheins/local-memory-mcp
|
|
24
|
+
```
|
|
25
|
+
|
|
18
26
|
## Installation
|
|
19
27
|
|
|
28
|
+
### Local Development
|
|
29
|
+
|
|
20
30
|
```bash
|
|
21
31
|
npm install
|
|
22
32
|
npm run build
|
|
23
33
|
```
|
|
24
34
|
|
|
35
|
+
### Global Install
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npm install -g @vheins/local-memory-mcp
|
|
39
|
+
mcp-memory-local
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## MCP Client Configuration
|
|
43
|
+
|
|
44
|
+
This server works with any MCP-compatible client. Add it to your configuration:
|
|
45
|
+
|
|
46
|
+
### OpenCode
|
|
47
|
+
|
|
48
|
+
```json
|
|
49
|
+
{
|
|
50
|
+
"mcpServers": {
|
|
51
|
+
"local-memory": {
|
|
52
|
+
"command": "npx",
|
|
53
|
+
"args": ["@vheins/local-memory-mcp"]
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Claude Desktop (claude.ai)
|
|
60
|
+
|
|
61
|
+
**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
62
|
+
|
|
63
|
+
**Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
|
|
64
|
+
|
|
65
|
+
```json
|
|
66
|
+
{
|
|
67
|
+
"mcpServers": {
|
|
68
|
+
"local-memory": {
|
|
69
|
+
"command": "npx",
|
|
70
|
+
"args": ["@vheins/local-memory-mcp"]
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### Cursor
|
|
77
|
+
|
|
78
|
+
Settings → Features → Models → "Edit JSON"
|
|
79
|
+
|
|
80
|
+
```json
|
|
81
|
+
{
|
|
82
|
+
"mcpServers": {
|
|
83
|
+
"local-memory": {
|
|
84
|
+
"command": "npx",
|
|
85
|
+
"args": ["@vheins/local-memory-mcp"]
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Kiro Antigravity
|
|
92
|
+
|
|
93
|
+
Add to your MCP configuration file:
|
|
94
|
+
|
|
95
|
+
```json
|
|
96
|
+
{
|
|
97
|
+
"servers": {
|
|
98
|
+
"local-memory": {
|
|
99
|
+
"command": "npx",
|
|
100
|
+
"args": ["@vheins/local-memory-mcp"]
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Trae
|
|
107
|
+
|
|
108
|
+
Settings → Integrations → MCP → Add Server
|
|
109
|
+
|
|
110
|
+
```json
|
|
111
|
+
{
|
|
112
|
+
"command": "npx",
|
|
113
|
+
"args": ["@vheins/local-memory-mcp"]
|
|
114
|
+
}
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### Gemini CLI
|
|
118
|
+
|
|
119
|
+
```bash
|
|
120
|
+
gemini mcp add local-memory -- npx @vheins/local-memory-mcp
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
### Codex
|
|
124
|
+
|
|
125
|
+
```json
|
|
126
|
+
{
|
|
127
|
+
"mcp_servers": {
|
|
128
|
+
"local-memory": {
|
|
129
|
+
"command": "npx",
|
|
130
|
+
"args": ["@vheins/local-memory-mcp"]
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### VS Code (with MCP extension)
|
|
137
|
+
|
|
138
|
+
```json
|
|
139
|
+
{
|
|
140
|
+
"mcpServers": {
|
|
141
|
+
"local-memory": {
|
|
142
|
+
"command": "npx",
|
|
143
|
+
"args": ["@vheins/local-memory-mcp"]
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
### Other MCP Clients
|
|
150
|
+
|
|
151
|
+
For any other MCP-compatible client, use:
|
|
152
|
+
|
|
153
|
+
- **Command**: `npx`
|
|
154
|
+
- **Args**: `["@vheins/local-memory-mcp"]`
|
|
155
|
+
|
|
156
|
+
Or build from source:
|
|
157
|
+
|
|
158
|
+
- **Command**: `node`
|
|
159
|
+
- **Args**: `["/path/to/dist/server.js"]`
|
|
160
|
+
|
|
25
161
|
## Usage
|
|
26
162
|
|
|
27
163
|
### MCP Server
|
package/package.json
CHANGED
|
@@ -1,9 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vheins/local-memory-mcp",
|
|
3
|
-
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"description": "MCP Local Memory Service for coding copilot agents",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/server.js",
|
|
7
|
+
"bin": {
|
|
8
|
+
"local-memory-mcp": "./dist/server.js"
|
|
9
|
+
},
|
|
10
|
+
"author": "Muhammad Rheza Alfin <m.rheza.alfin@gmail.com>",
|
|
11
|
+
"license": "MIT",
|
|
7
12
|
"scripts": {
|
|
8
13
|
"build": "tsc && mkdir -p dist/dashboard/public && rsync -a --delete src/dashboard/public/ dist/dashboard/public/",
|
|
9
14
|
"dev": "tsc --watch",
|
|
@@ -13,14 +18,6 @@
|
|
|
13
18
|
"test": "vitest --run",
|
|
14
19
|
"test:watch": "vitest"
|
|
15
20
|
},
|
|
16
|
-
"keywords": [
|
|
17
|
-
"mcp",
|
|
18
|
-
"memory",
|
|
19
|
-
"ai",
|
|
20
|
-
"coding-copilot"
|
|
21
|
-
],
|
|
22
|
-
"author": "",
|
|
23
|
-
"license": "MIT",
|
|
24
21
|
"dependencies": {
|
|
25
22
|
"better-sqlite3": "^12.6.2",
|
|
26
23
|
"express": "^5.2.1",
|