mcp-sqlite-memory-bank 1.2.3__tar.gz → 1.2.4__tar.gz

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.
Files changed (19) hide show
  1. {mcp_sqlite_memory_bank-1.2.3/src/mcp_sqlite_memory_bank.egg-info → mcp_sqlite_memory_bank-1.2.4}/PKG-INFO +137 -90
  2. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4}/README.md +136 -89
  3. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4}/pyproject.toml +1 -1
  4. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4/src/mcp_sqlite_memory_bank.egg-info}/PKG-INFO +137 -90
  5. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4}/LICENSE +0 -0
  6. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4}/MANIFEST.in +0 -0
  7. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4}/setup.cfg +0 -0
  8. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4}/src/mcp_sqlite_memory_bank/__init__.py +0 -0
  9. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4}/src/mcp_sqlite_memory_bank/py.typed +0 -0
  10. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4}/src/mcp_sqlite_memory_bank/server.py +0 -0
  11. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4}/src/mcp_sqlite_memory_bank/types.py +0 -0
  12. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4}/src/mcp_sqlite_memory_bank/utils.py +0 -0
  13. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4}/src/mcp_sqlite_memory_bank.egg-info/SOURCES.txt +0 -0
  14. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4}/src/mcp_sqlite_memory_bank.egg-info/dependency_links.txt +0 -0
  15. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4}/src/mcp_sqlite_memory_bank.egg-info/entry_points.txt +0 -0
  16. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4}/src/mcp_sqlite_memory_bank.egg-info/requires.txt +0 -0
  17. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4}/src/mcp_sqlite_memory_bank.egg-info/top_level.txt +0 -0
  18. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4}/tests/test_api.py +0 -0
  19. {mcp_sqlite_memory_bank-1.2.3 → mcp_sqlite_memory_bank-1.2.4}/tests/test_server.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mcp_sqlite_memory_bank
3
- Version: 1.2.3
3
+ Version: 1.2.4
4
4
  Summary: A dynamic, agent/LLM-friendly SQLite memory bank for MCP servers.
5
5
  Author-email: Robert Meisner <robert@catchit.pl>
6
6
  License-Expression: MIT
@@ -45,6 +45,60 @@ This project provides a robust, discoverable API for creating, exploring, and ma
45
45
 
46
46
  ---
47
47
 
48
+ ## Quick Start
49
+
50
+ Get started with SQLite Memory Bank in your IDE in under 2 minutes:
51
+
52
+ ### 1. Install and Run
53
+ ```bash
54
+ # Install uvx if you don't have it
55
+ pip install uvx
56
+
57
+ # Run SQLite Memory Bank
58
+ uvx mcp-sqlite-memory-bank
59
+ ```
60
+
61
+ ### 2. Configure Your IDE
62
+
63
+ **VS Code / Cursor:** Add to `.vscode/mcp.json`:
64
+ ```jsonc
65
+ {
66
+ "servers": {
67
+ "SQLite_Memory": {
68
+ "type": "stdio",
69
+ "command": "uvx",
70
+ "args": ["--refresh", "mcp-sqlite-memory-bank"],
71
+ "env": {
72
+ "DB_PATH": "${workspaceFolder}/.vscode/project_memory.sqlite"
73
+ }
74
+ }
75
+ }
76
+ }
77
+ ```
78
+
79
+ **Claude Desktop:** Add to `claude_desktop_config.json`:
80
+ ```jsonc
81
+ {
82
+ "mcpServers": {
83
+ "sqlite_memory": {
84
+ "command": "uvx",
85
+ "args": ["mcp-sqlite-memory-bank"],
86
+ "env": {
87
+ "DB_PATH": "/path/to/your/memory.db"
88
+ }
89
+ }
90
+ }
91
+ }
92
+ ```
93
+
94
+ ### 3. Test It
95
+ Restart your IDE and try asking your AI assistant:
96
+ > "Create a table called 'notes' with columns 'id' (integer, primary key) and 'content' (text). Then add a note saying 'Hello SQLite Memory Bank!'"
97
+
98
+ ✅ You should see the AI using the SQLite Memory Bank tools to create the table and add the note!
99
+
100
+ ---
101
+
48
102
  ## Features
49
103
 
50
104
  - **Dynamic Table Management:** Create, list, describe, rename, and drop tables at runtime
@@ -86,6 +140,22 @@ Each tool validates inputs and returns consistent response formats with success/
86
140
 
87
141
  ---
88
142
 
143
+ ## Transport Modes
144
+
145
+ ### Stdio Mode (Default)
146
+ - **Use case**: MCP clients (VS Code, Claude Desktop, etc.)
147
+ - **Protocol**: JSON-RPC over stdin/stdout
148
+ - **Command**: `uvx mcp-sqlite-memory-bank`
149
+ - **Benefits**: Direct integration with AI assistants and IDEs
150
+
151
+ ### HTTP Mode (Development)
152
+ - **Use case**: Development, testing, web APIs
153
+ - **Protocol**: HTTP REST API
154
+ - **Command**: `python -m mcp_sqlite_memory_bank.server main --port 8000`
155
+ - **Benefits**: Web browser access, curl testing, API integration
156
+
157
+ ---
158
+
89
159
  ## Installation & Transport Options
90
160
 
91
161
  **Requirements:**
@@ -111,47 +181,29 @@ python -m pip install --user pipx
111
181
  pipx run mcp_sqlite_memory_bank
112
182
  ```
113
183
 
114
- ### Option 4: Run via UVX
184
+ ### Option 4: Run via UVX (Recommended for MCP clients)
115
185
  ```bash
116
- # Install UVX if you don't have it
117
- curl -fsSL https://uvx.zip/install.sh | bash
118
-
119
- # Run directly without installation
120
- uvx run mcp_sqlite_memory_bank
186
+ # Run directly with latest version (recommended)
187
+ uvx mcp-sqlite-memory-bank
121
188
 
122
- # Or, specify a version
123
- uvx run mcp_sqlite_memory_bank@latest
189
+ # Force refresh to get latest updates
190
+ uvx --refresh mcp-sqlite-memory-bank
124
191
  ```
125
192
 
126
- ### Option 5: Docker (Containerized) # Coming soon - not yet implemented
127
- ```bash
128
- # Pull the image
129
- docker pull robertmeisner/mcp_sqlite_memory_bank:latest
130
-
131
- # Run with stdio transport (for Claude Desktop)
132
- docker run -i --rm \
133
- --mount type=bind,src=/path/to/data/dir,dst=/data \
134
- robertmeisner/mcp_sqlite_memory_bank:latest stdio
135
-
136
- # Run with HTTP transport (for API access)
137
- docker run -p 8000:8000 --rm \
138
- --mount type=bind,src=/path/to/data/dir,dst=/data \
139
- robertmeisner/mcp_sqlite_memory_bank:latest http
140
- ```
193
+ ---
141
194
 
142
195
  ### Transport Options
143
196
 
144
- SQLite Memory Bank currently supports:
145
-
146
- - **stdio** (default): For direct integration with Claude Desktop and other MCP clients
197
+ SQLite Memory Bank currently supports **stdio transport** for MCP clients:
147
198
 
148
- Planned transport options (not yet implemented):
149
- - **http**: For web access and API usage
150
- - **streamable-http**: For the latest MCP specification
199
+ **Stdio Transport (Default - for MCP clients like VS Code, Claude Desktop):**
200
+ ```bash
201
+ uvx mcp-sqlite-memory-bank
202
+ ```
151
203
 
152
- Run with the default transport:
204
+ **HTTP Transport (Development/Testing only):**
153
205
  ```bash
154
- python -m mcp_sqlite_memory_bank.server
206
+ python -m mcp_sqlite_memory_bank.server main --host 127.0.0.1 --port 8000
155
207
  ```
156
208
 
157
209
  ---
@@ -175,11 +227,6 @@ DB_PATH=./test.db
175
227
 
176
228
  ### VS Code Integration
177
229
 
178
- #### Quick Install
179
- [Install with Python Module in VS Code](https://insiders.vscode.dev/redirect/mcp/install?name=sqlite-memory&config=%7B%22command%22%3A%22python%22%2C%22args%22%3A%5B%22-m%22%2C%22mcp_sqlite_memory_bank%22%5D%7D)
180
-
181
- [Install with Docker in VS Code](https://insiders.vscode.dev/redirect/mcp/install?name=sqlite-memory&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22--rm%22%2C%22--mount%22%2C%22type%3Dbind%2Csrc%3D%24%7BworkspaceFolder%7D%2Cdst%3D%2Fdata%22%2C%22robertmeisner%2Fmcp_sqlite_memory_bank%3Alatest%22%5D%7D)
182
-
183
230
  #### Manual Configuration
184
231
 
185
232
  Add or update `.vscode/mcp.json` in your project root:
@@ -188,23 +235,16 @@ Add or update `.vscode/mcp.json` in your project root:
188
235
  "servers": {
189
236
  "SQLite_Memory": {
190
237
  "type": "stdio",
191
- "command": "python",
192
- "args": ["-m", "mcp_sqlite_memory_bank.server"],
238
+ "command": "uvx",
239
+ "args": ["--refresh", "mcp-sqlite-memory-bank"],
193
240
  "env": {
194
- "DB_PATH": "${workspaceFolder}/data/memory.db"
241
+ "DB_PATH": "${workspaceFolder}/.vscode/project_memory.sqlite"
195
242
  }
196
243
  }
197
244
  }
198
245
  }
199
246
  ```
200
247
 
201
- ## FastMCP Integration (Planned)
202
-
203
- ```bash
204
- # Coming soon - not yet implemented
205
- fastmcp install mcp_sqlite_memory_bank/server.py --name "SQLite Memory Bank"
206
- ```
207
-
208
248
  ### Claude Desktop Integration
209
249
 
210
250
  Add to your `claude_desktop_config.json`:
@@ -213,8 +253,8 @@ Add to your `claude_desktop_config.json`:
213
253
  {
214
254
  "mcpServers": {
215
255
  "sqlite_memory": {
216
- "command": "python",
217
- "args": ["-m", "mcp_sqlite_memory_bank.server"],
256
+ "command": "uvx",
257
+ "args": ["mcp-sqlite-memory-bank"],
218
258
  "env": {
219
259
  "DB_PATH": "/path/to/your/memory.db"
220
260
  }
@@ -223,28 +263,6 @@ Add to your `claude_desktop_config.json`:
223
263
  }
224
264
  ```
225
265
 
226
- #### Docker Option for Claude Desktop
227
-
228
- ```jsonc
229
- {
230
- "mcpServers": {
231
- "sqlite_memory": {
232
- "command": "docker",
233
- "args": [
234
- "run",
235
- "-i",
236
- "--rm",
237
- "--mount", "type=bind,src=/path/to/data/dir,dst=/data",
238
- "robertmeisner/mcp_sqlite_memory_bank:latest"
239
- ],
240
- "env": {
241
- "DB_PATH": "/data/memory.db"
242
- }
243
- }
244
- }
245
- }
246
- ```
247
-
248
266
  - Open your project in VS Code, Cursor, or Claude Desktop. The MCP server will be auto-discovered by Copilot Chat, Cursor, Claude, or any compatible agent.
249
267
  - Use natural language to create tables, store notes, or build knowledge graphs.
250
268
 
@@ -252,36 +270,28 @@ Add to your `claude_desktop_config.json`:
252
270
 
253
271
  ## Running the Server
254
272
 
255
- ### Transport Options
273
+ ### MCP Stdio Mode (Recommended)
256
274
 
257
- SQLite Memory Bank currently supports stdio transport only:
275
+ For use with VS Code, Claude Desktop, and other MCP clients:
258
276
 
259
- **Stdio Transport (Default - for Claude Desktop):**
260
277
  ```bash
261
- python -m mcp_sqlite_memory_bank.server
262
- ```
278
+ # Run with uvx (automatically gets latest version)
279
+ uvx mcp-sqlite-memory-bank
263
280
 
264
- **HTTP Transport (REST API - Planned):**
265
- ```bash
266
- # Coming soon - not yet implemented
267
- python -m mcp_sqlite_memory_bank.server http --port 8000
281
+ # Force refresh to latest version
282
+ uvx --refresh mcp-sqlite-memory-bank
268
283
  ```
269
284
 
270
- **Streamable HTTP Transport (Latest MCP Spec - Planned):**
271
- ```bash
272
- # Coming soon - not yet implemented
273
- python -m mcp_sqlite_memory_bank.server streamable-http --port 8000
274
- ```
285
+ ### Development/Testing Modes
275
286
 
276
- **With the example runner:**
287
+ **HTTP Server Mode (for development and testing):**
277
288
  ```bash
278
- python examples/run_server.py
289
+ python -m mcp_sqlite_memory_bank.server main --port 8000
279
290
  ```
280
291
 
281
- **With FastMCP (Planned):**
292
+ **Direct Python Module:**
282
293
  ```bash
283
- # Coming soon - not yet implemented
284
- fastmcp install mcp_sqlite_memory_bank/server.py --name "SQLite Memory Bank"
294
+ python -m mcp_sqlite_memory_bank.server
285
295
  ```
286
296
 
287
297
  ---
@@ -403,6 +413,43 @@ For a complete agent memory implementation example, see [examples/agent_memory_e
403
413
 
404
414
  ---
405
415
 
416
+ ## Troubleshooting
417
+
418
+ ### Common MCP Connection Issues
419
+
420
+ **Server not starting / Connection timeout:**
421
+ ```bash
422
+ # Force refresh uvx cache and try again
423
+ uvx --refresh mcp-sqlite-memory-bank
424
+
425
+ # Check if the command works directly
426
+ uvx mcp-sqlite-memory-bank --help
427
+ ```
428
+
429
+ **VS Code: "Server exited before responding to initialize request":**
430
+ 1. Check the MCP configuration in `.vscode/mcp.json`
431
+ 2. Ensure `uvx` is installed and in your PATH
432
+ 3. Try restarting VS Code or running "MCP: Restart Server" from Command Palette
433
+
434
+ **Tools not appearing in IDE:**
435
+ 1. Verify the server is running: `uvx mcp-sqlite-memory-bank` should start without errors
436
+ 2. Check that `"type": "stdio"` is set in your MCP configuration
437
+ 3. Restart your IDE or reload MCP configuration
438
+
439
+ **Database permission errors:**
440
+ - Ensure the directory for `DB_PATH` exists and is writable
441
+ - Check file permissions on the SQLite database file
442
+ - Use absolute paths in `DB_PATH` to avoid path resolution issues
443
+
444
+ **Package not found / outdated version:**
445
+ ```bash
446
+ # Clear uvx cache completely
447
+ uvx cache remove mcp-sqlite-memory-bank
448
+ uvx mcp-sqlite-memory-bank
449
+ ```
450
+
451
+ ---
452
+
406
453
 
407
454
  ## Running Tests
408
455
 
@@ -23,6 +23,60 @@ This project provides a robust, discoverable API for creating, exploring, and ma
23
23
 
24
24
  ---
25
25
 
26
+ ## Quick Start
27
+
28
+ Get started with SQLite Memory Bank in your IDE in under 2 minutes:
29
+
30
+ ### 1. Install and Run
31
+ ```bash
32
+ # Install uvx if you don't have it
33
+ pip install uvx
34
+
35
+ # Run SQLite Memory Bank
36
+ uvx mcp-sqlite-memory-bank
37
+ ```
38
+
39
+ ### 2. Configure Your IDE
40
+
41
+ **VS Code / Cursor:** Add to `.vscode/mcp.json`:
42
+ ```jsonc
43
+ {
44
+ "servers": {
45
+ "SQLite_Memory": {
46
+ "type": "stdio",
47
+ "command": "uvx",
48
+ "args": ["--refresh", "mcp-sqlite-memory-bank"],
49
+ "env": {
50
+ "DB_PATH": "${workspaceFolder}/.vscode/project_memory.sqlite"
51
+ }
52
+ }
53
+ }
54
+ }
55
+ ```
56
+
57
+ **Claude Desktop:** Add to `claude_desktop_config.json`:
58
+ ```jsonc
59
+ {
60
+ "mcpServers": {
61
+ "sqlite_memory": {
62
+ "command": "uvx",
63
+ "args": ["mcp-sqlite-memory-bank"],
64
+ "env": {
65
+ "DB_PATH": "/path/to/your/memory.db"
66
+ }
67
+ }
68
+ }
69
+ }
70
+ ```
71
+
72
+ ### 3. Test It
73
+ Restart your IDE and try asking your AI assistant:
74
+ > "Create a table called 'notes' with columns 'id' (integer, primary key) and 'content' (text). Then add a note saying 'Hello SQLite Memory Bank!'"
75
+
76
+ ✅ You should see the AI using the SQLite Memory Bank tools to create the table and add the note!
77
+
78
+ ---
79
+
26
80
  ## Features
27
81
 
28
82
  - **Dynamic Table Management:** Create, list, describe, rename, and drop tables at runtime
@@ -64,6 +118,22 @@ Each tool validates inputs and returns consistent response formats with success/
64
118
 
65
119
  ---
66
120
 
121
+ ## Transport Modes
122
+
123
+ ### Stdio Mode (Default)
124
+ - **Use case**: MCP clients (VS Code, Claude Desktop, etc.)
125
+ - **Protocol**: JSON-RPC over stdin/stdout
126
+ - **Command**: `uvx mcp-sqlite-memory-bank`
127
+ - **Benefits**: Direct integration with AI assistants and IDEs
128
+
129
+ ### HTTP Mode (Development)
130
+ - **Use case**: Development, testing, web APIs
131
+ - **Protocol**: HTTP REST API
132
+ - **Command**: `python -m mcp_sqlite_memory_bank.server main --port 8000`
133
+ - **Benefits**: Web browser access, curl testing, API integration
134
+
135
+ ---
136
+
67
137
  ## Installation & Transport Options
68
138
 
69
139
  **Requirements:**
@@ -89,47 +159,29 @@ python -m pip install --user pipx
89
159
  pipx run mcp_sqlite_memory_bank
90
160
  ```
91
161
 
92
- ### Option 4: Run via UVX
162
+ ### Option 4: Run via UVX (Recommended for MCP clients)
93
163
  ```bash
94
- # Install UVX if you don't have it
95
- curl -fsSL https://uvx.zip/install.sh | bash
96
-
97
- # Run directly without installation
98
- uvx run mcp_sqlite_memory_bank
164
+ # Run directly with latest version (recommended)
165
+ uvx mcp-sqlite-memory-bank
99
166
 
100
- # Or, specify a version
101
- uvx run mcp_sqlite_memory_bank@latest
167
+ # Force refresh to get latest updates
168
+ uvx --refresh mcp-sqlite-memory-bank
102
169
  ```
103
170
 
104
- ### Option 5: Docker (Containerized) # Coming soon - not yet implemented
105
- ```bash
106
- # Pull the image
107
- docker pull robertmeisner/mcp_sqlite_memory_bank:latest
108
-
109
- # Run with stdio transport (for Claude Desktop)
110
- docker run -i --rm \
111
- --mount type=bind,src=/path/to/data/dir,dst=/data \
112
- robertmeisner/mcp_sqlite_memory_bank:latest stdio
113
-
114
- # Run with HTTP transport (for API access)
115
- docker run -p 8000:8000 --rm \
116
- --mount type=bind,src=/path/to/data/dir,dst=/data \
117
- robertmeisner/mcp_sqlite_memory_bank:latest http
118
- ```
171
+ ---
119
172
 
120
173
  ### Transport Options
121
174
 
122
- SQLite Memory Bank currently supports:
123
-
124
- - **stdio** (default): For direct integration with Claude Desktop and other MCP clients
175
+ SQLite Memory Bank currently supports **stdio transport** for MCP clients:
125
176
 
126
- Planned transport options (not yet implemented):
127
- - **http**: For web access and API usage
128
- - **streamable-http**: For the latest MCP specification
177
+ **Stdio Transport (Default - for MCP clients like VS Code, Claude Desktop):**
178
+ ```bash
179
+ uvx mcp-sqlite-memory-bank
180
+ ```
129
181
 
130
- Run with the default transport:
182
+ **HTTP Transport (Development/Testing only):**
131
183
  ```bash
132
- python -m mcp_sqlite_memory_bank.server
184
+ python -m mcp_sqlite_memory_bank.server main --host 127.0.0.1 --port 8000
133
185
  ```
134
186
 
135
187
  ---
@@ -153,11 +205,6 @@ DB_PATH=./test.db
153
205
 
154
206
  ### VS Code Integration
155
207
 
156
- #### Quick Install
157
- [Install with Python Module in VS Code](https://insiders.vscode.dev/redirect/mcp/install?name=sqlite-memory&config=%7B%22command%22%3A%22python%22%2C%22args%22%3A%5B%22-m%22%2C%22mcp_sqlite_memory_bank%22%5D%7D)
158
-
159
- [Install with Docker in VS Code](https://insiders.vscode.dev/redirect/mcp/install?name=sqlite-memory&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22--rm%22%2C%22--mount%22%2C%22type%3Dbind%2Csrc%3D%24%7BworkspaceFolder%7D%2Cdst%3D%2Fdata%22%2C%22robertmeisner%2Fmcp_sqlite_memory_bank%3Alatest%22%5D%7D)
160
-
161
208
  #### Manual Configuration
162
209
 
163
210
  Add or update `.vscode/mcp.json` in your project root:
@@ -166,23 +213,16 @@ Add or update `.vscode/mcp.json` in your project root:
166
213
  "servers": {
167
214
  "SQLite_Memory": {
168
215
  "type": "stdio",
169
- "command": "python",
170
- "args": ["-m", "mcp_sqlite_memory_bank.server"],
216
+ "command": "uvx",
217
+ "args": ["--refresh", "mcp-sqlite-memory-bank"],
171
218
  "env": {
172
- "DB_PATH": "${workspaceFolder}/data/memory.db"
219
+ "DB_PATH": "${workspaceFolder}/.vscode/project_memory.sqlite"
173
220
  }
174
221
  }
175
222
  }
176
223
  }
177
224
  ```
178
225
 
179
- ## FastMCP Integration (Planned)
180
-
181
- ```bash
182
- # Coming soon - not yet implemented
183
- fastmcp install mcp_sqlite_memory_bank/server.py --name "SQLite Memory Bank"
184
- ```
185
-
186
226
  ### Claude Desktop Integration
187
227
 
188
228
  Add to your `claude_desktop_config.json`:
@@ -191,8 +231,8 @@ Add to your `claude_desktop_config.json`:
191
231
  {
192
232
  "mcpServers": {
193
233
  "sqlite_memory": {
194
- "command": "python",
195
- "args": ["-m", "mcp_sqlite_memory_bank.server"],
234
+ "command": "uvx",
235
+ "args": ["mcp-sqlite-memory-bank"],
196
236
  "env": {
197
237
  "DB_PATH": "/path/to/your/memory.db"
198
238
  }
@@ -201,28 +241,6 @@ Add to your `claude_desktop_config.json`:
201
241
  }
202
242
  ```
203
243
 
204
- #### Docker Option for Claude Desktop
205
-
206
- ```jsonc
207
- {
208
- "mcpServers": {
209
- "sqlite_memory": {
210
- "command": "docker",
211
- "args": [
212
- "run",
213
- "-i",
214
- "--rm",
215
- "--mount", "type=bind,src=/path/to/data/dir,dst=/data",
216
- "robertmeisner/mcp_sqlite_memory_bank:latest"
217
- ],
218
- "env": {
219
- "DB_PATH": "/data/memory.db"
220
- }
221
- }
222
- }
223
- }
224
- ```
225
-
226
244
  - Open your project in VS Code, Cursor, or Claude Desktop. The MCP server will be auto-discovered by Copilot Chat, Cursor, Claude, or any compatible agent.
227
245
  - Use natural language to create tables, store notes, or build knowledge graphs.
228
246
 
@@ -230,36 +248,28 @@ Add to your `claude_desktop_config.json`:
230
248
 
231
249
  ## Running the Server
232
250
 
233
- ### Transport Options
251
+ ### MCP Stdio Mode (Recommended)
234
252
 
235
- SQLite Memory Bank currently supports stdio transport only:
253
+ For use with VS Code, Claude Desktop, and other MCP clients:
236
254
 
237
- **Stdio Transport (Default - for Claude Desktop):**
238
255
  ```bash
239
- python -m mcp_sqlite_memory_bank.server
240
- ```
256
+ # Run with uvx (automatically gets latest version)
257
+ uvx mcp-sqlite-memory-bank
241
258
 
242
- **HTTP Transport (REST API - Planned):**
243
- ```bash
244
- # Coming soon - not yet implemented
245
- python -m mcp_sqlite_memory_bank.server http --port 8000
259
+ # Force refresh to latest version
260
+ uvx --refresh mcp-sqlite-memory-bank
246
261
  ```
247
262
 
248
- **Streamable HTTP Transport (Latest MCP Spec - Planned):**
249
- ```bash
250
- # Coming soon - not yet implemented
251
- python -m mcp_sqlite_memory_bank.server streamable-http --port 8000
252
- ```
263
+ ### Development/Testing Modes
253
264
 
254
- **With the example runner:**
265
+ **HTTP Server Mode (for development and testing):**
255
266
  ```bash
256
- python examples/run_server.py
267
+ python -m mcp_sqlite_memory_bank.server main --port 8000
257
268
  ```
258
269
 
259
- **With FastMCP (Planned):**
270
+ **Direct Python Module:**
260
271
  ```bash
261
- # Coming soon - not yet implemented
262
- fastmcp install mcp_sqlite_memory_bank/server.py --name "SQLite Memory Bank"
272
+ python -m mcp_sqlite_memory_bank.server
263
273
  ```
264
274
 
265
275
  ---
@@ -381,6 +391,43 @@ For a complete agent memory implementation example, see [examples/agent_memory_e
381
391
 
382
392
  ---
383
393
 
394
+ ## Troubleshooting
395
+
396
+ ### Common MCP Connection Issues
397
+
398
+ **Server not starting / Connection timeout:**
399
+ ```bash
400
+ # Force refresh uvx cache and try again
401
+ uvx --refresh mcp-sqlite-memory-bank
402
+
403
+ # Check if the command works directly
404
+ uvx mcp-sqlite-memory-bank --help
405
+ ```
406
+
407
+ **VS Code: "Server exited before responding to initialize request":**
408
+ 1. Check the MCP configuration in `.vscode/mcp.json`
409
+ 2. Ensure `uvx` is installed and in your PATH
410
+ 3. Try restarting VS Code or running "MCP: Restart Server" from Command Palette
411
+
412
+ **Tools not appearing in IDE:**
413
+ 1. Verify the server is running: `uvx mcp-sqlite-memory-bank` should start without errors
414
+ 2. Check that `"type": "stdio"` is set in your MCP configuration
415
+ 3. Restart your IDE or reload MCP configuration
416
+
417
+ **Database permission errors:**
418
+ - Ensure the directory for `DB_PATH` exists and is writable
419
+ - Check file permissions on the SQLite database file
420
+ - Use absolute paths in `DB_PATH` to avoid path resolution issues
421
+
422
+ **Package not found / outdated version:**
423
+ ```bash
424
+ # Clear uvx cache completely
425
+ uvx cache remove mcp-sqlite-memory-bank
426
+ uvx mcp-sqlite-memory-bank
427
+ ```
428
+
429
+ ---
430
+
384
431
 
385
432
  ## Running Tests
386
433
 
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "mcp_sqlite_memory_bank"
7
- version = "1.2.3"
7
+ version = "1.2.4"
8
8
  description = "A dynamic, agent/LLM-friendly SQLite memory bank for MCP servers."
9
9
  authors = [
10
10
  { name="Robert Meisner", email="robert@catchit.pl" }
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mcp_sqlite_memory_bank
3
- Version: 1.2.3
3
+ Version: 1.2.4
4
4
  Summary: A dynamic, agent/LLM-friendly SQLite memory bank for MCP servers.
5
5
  Author-email: Robert Meisner <robert@catchit.pl>
6
6
  License-Expression: MIT
@@ -45,6 +45,60 @@ This project provides a robust, discoverable API for creating, exploring, and ma
45
45
 
46
46
  ---
47
47
 
48
+ ## Quick Start
49
+
50
+ Get started with SQLite Memory Bank in your IDE in under 2 minutes:
51
+
52
+ ### 1. Install and Run
53
+ ```bash
54
+ # Install uvx if you don't have it
55
+ pip install uvx
56
+
57
+ # Run SQLite Memory Bank
58
+ uvx mcp-sqlite-memory-bank
59
+ ```
60
+
61
+ ### 2. Configure Your IDE
62
+
63
+ **VS Code / Cursor:** Add to `.vscode/mcp.json`:
64
+ ```jsonc
65
+ {
66
+ "servers": {
67
+ "SQLite_Memory": {
68
+ "type": "stdio",
69
+ "command": "uvx",
70
+ "args": ["--refresh", "mcp-sqlite-memory-bank"],
71
+ "env": {
72
+ "DB_PATH": "${workspaceFolder}/.vscode/project_memory.sqlite"
73
+ }
74
+ }
75
+ }
76
+ }
77
+ ```
78
+
79
+ **Claude Desktop:** Add to `claude_desktop_config.json`:
80
+ ```jsonc
81
+ {
82
+ "mcpServers": {
83
+ "sqlite_memory": {
84
+ "command": "uvx",
85
+ "args": ["mcp-sqlite-memory-bank"],
86
+ "env": {
87
+ "DB_PATH": "/path/to/your/memory.db"
88
+ }
89
+ }
90
+ }
91
+ }
92
+ ```
93
+
94
+ ### 3. Test It
95
+ Restart your IDE and try asking your AI assistant:
96
+ > "Create a table called 'notes' with columns 'id' (integer, primary key) and 'content' (text). Then add a note saying 'Hello SQLite Memory Bank!'"
97
+
98
+ ✅ You should see the AI using the SQLite Memory Bank tools to create the table and add the note!
99
+
100
+ ---
101
+
48
102
  ## Features
49
103
 
50
104
  - **Dynamic Table Management:** Create, list, describe, rename, and drop tables at runtime
@@ -86,6 +140,22 @@ Each tool validates inputs and returns consistent response formats with success/
86
140
 
87
141
  ---
88
142
 
143
+ ## Transport Modes
144
+
145
+ ### Stdio Mode (Default)
146
+ - **Use case**: MCP clients (VS Code, Claude Desktop, etc.)
147
+ - **Protocol**: JSON-RPC over stdin/stdout
148
+ - **Command**: `uvx mcp-sqlite-memory-bank`
149
+ - **Benefits**: Direct integration with AI assistants and IDEs
150
+
151
+ ### HTTP Mode (Development)
152
+ - **Use case**: Development, testing, web APIs
153
+ - **Protocol**: HTTP REST API
154
+ - **Command**: `python -m mcp_sqlite_memory_bank.server main --port 8000`
155
+ - **Benefits**: Web browser access, curl testing, API integration
156
+
157
+ ---
158
+
89
159
  ## Installation & Transport Options
90
160
 
91
161
  **Requirements:**
@@ -111,47 +181,29 @@ python -m pip install --user pipx
111
181
  pipx run mcp_sqlite_memory_bank
112
182
  ```
113
183
 
114
- ### Option 4: Run via UVX
184
+ ### Option 4: Run via UVX (Recommended for MCP clients)
115
185
  ```bash
116
- # Install UVX if you don't have it
117
- curl -fsSL https://uvx.zip/install.sh | bash
118
-
119
- # Run directly without installation
120
- uvx run mcp_sqlite_memory_bank
186
+ # Run directly with latest version (recommended)
187
+ uvx mcp-sqlite-memory-bank
121
188
 
122
- # Or, specify a version
123
- uvx run mcp_sqlite_memory_bank@latest
189
+ # Force refresh to get latest updates
190
+ uvx --refresh mcp-sqlite-memory-bank
124
191
  ```
125
192
 
126
- ### Option 5: Docker (Containerized) # Coming soon - not yet implemented
127
- ```bash
128
- # Pull the image
129
- docker pull robertmeisner/mcp_sqlite_memory_bank:latest
130
-
131
- # Run with stdio transport (for Claude Desktop)
132
- docker run -i --rm \
133
- --mount type=bind,src=/path/to/data/dir,dst=/data \
134
- robertmeisner/mcp_sqlite_memory_bank:latest stdio
135
-
136
- # Run with HTTP transport (for API access)
137
- docker run -p 8000:8000 --rm \
138
- --mount type=bind,src=/path/to/data/dir,dst=/data \
139
- robertmeisner/mcp_sqlite_memory_bank:latest http
140
- ```
193
+ ---
141
194
 
142
195
  ### Transport Options
143
196
 
144
- SQLite Memory Bank currently supports:
145
-
146
- - **stdio** (default): For direct integration with Claude Desktop and other MCP clients
197
+ SQLite Memory Bank currently supports **stdio transport** for MCP clients:
147
198
 
148
- Planned transport options (not yet implemented):
149
- - **http**: For web access and API usage
150
- - **streamable-http**: For the latest MCP specification
199
+ **Stdio Transport (Default - for MCP clients like VS Code, Claude Desktop):**
200
+ ```bash
201
+ uvx mcp-sqlite-memory-bank
202
+ ```
151
203
 
152
- Run with the default transport:
204
+ **HTTP Transport (Development/Testing only):**
153
205
  ```bash
154
- python -m mcp_sqlite_memory_bank.server
206
+ python -m mcp_sqlite_memory_bank.server main --host 127.0.0.1 --port 8000
155
207
  ```
156
208
 
157
209
  ---
@@ -175,11 +227,6 @@ DB_PATH=./test.db
175
227
 
176
228
  ### VS Code Integration
177
229
 
178
- #### Quick Install
179
- [Install with Python Module in VS Code](https://insiders.vscode.dev/redirect/mcp/install?name=sqlite-memory&config=%7B%22command%22%3A%22python%22%2C%22args%22%3A%5B%22-m%22%2C%22mcp_sqlite_memory_bank%22%5D%7D)
180
-
181
- [Install with Docker in VS Code](https://insiders.vscode.dev/redirect/mcp/install?name=sqlite-memory&config=%7B%22command%22%3A%22docker%22%2C%22args%22%3A%5B%22run%22%2C%22-i%22%2C%22--rm%22%2C%22--mount%22%2C%22type%3Dbind%2Csrc%3D%24%7BworkspaceFolder%7D%2Cdst%3D%2Fdata%22%2C%22robertmeisner%2Fmcp_sqlite_memory_bank%3Alatest%22%5D%7D)
182
-
183
230
  #### Manual Configuration
184
231
 
185
232
  Add or update `.vscode/mcp.json` in your project root:
@@ -188,23 +235,16 @@ Add or update `.vscode/mcp.json` in your project root:
188
235
  "servers": {
189
236
  "SQLite_Memory": {
190
237
  "type": "stdio",
191
- "command": "python",
192
- "args": ["-m", "mcp_sqlite_memory_bank.server"],
238
+ "command": "uvx",
239
+ "args": ["--refresh", "mcp-sqlite-memory-bank"],
193
240
  "env": {
194
- "DB_PATH": "${workspaceFolder}/data/memory.db"
241
+ "DB_PATH": "${workspaceFolder}/.vscode/project_memory.sqlite"
195
242
  }
196
243
  }
197
244
  }
198
245
  }
199
246
  ```
200
247
 
201
- ## FastMCP Integration (Planned)
202
-
203
- ```bash
204
- # Coming soon - not yet implemented
205
- fastmcp install mcp_sqlite_memory_bank/server.py --name "SQLite Memory Bank"
206
- ```
207
-
208
248
  ### Claude Desktop Integration
209
249
 
210
250
  Add to your `claude_desktop_config.json`:
@@ -213,8 +253,8 @@ Add to your `claude_desktop_config.json`:
213
253
  {
214
254
  "mcpServers": {
215
255
  "sqlite_memory": {
216
- "command": "python",
217
- "args": ["-m", "mcp_sqlite_memory_bank.server"],
256
+ "command": "uvx",
257
+ "args": ["mcp-sqlite-memory-bank"],
218
258
  "env": {
219
259
  "DB_PATH": "/path/to/your/memory.db"
220
260
  }
@@ -223,28 +263,6 @@ Add to your `claude_desktop_config.json`:
223
263
  }
224
264
  ```
225
265
 
226
- #### Docker Option for Claude Desktop
227
-
228
- ```jsonc
229
- {
230
- "mcpServers": {
231
- "sqlite_memory": {
232
- "command": "docker",
233
- "args": [
234
- "run",
235
- "-i",
236
- "--rm",
237
- "--mount", "type=bind,src=/path/to/data/dir,dst=/data",
238
- "robertmeisner/mcp_sqlite_memory_bank:latest"
239
- ],
240
- "env": {
241
- "DB_PATH": "/data/memory.db"
242
- }
243
- }
244
- }
245
- }
246
- ```
247
-
248
266
  - Open your project in VS Code, Cursor, or Claude Desktop. The MCP server will be auto-discovered by Copilot Chat, Cursor, Claude, or any compatible agent.
249
267
  - Use natural language to create tables, store notes, or build knowledge graphs.
250
268
 
@@ -252,36 +270,28 @@ Add to your `claude_desktop_config.json`:
252
270
 
253
271
  ## Running the Server
254
272
 
255
- ### Transport Options
273
+ ### MCP Stdio Mode (Recommended)
256
274
 
257
- SQLite Memory Bank currently supports stdio transport only:
275
+ For use with VS Code, Claude Desktop, and other MCP clients:
258
276
 
259
- **Stdio Transport (Default - for Claude Desktop):**
260
277
  ```bash
261
- python -m mcp_sqlite_memory_bank.server
262
- ```
278
+ # Run with uvx (automatically gets latest version)
279
+ uvx mcp-sqlite-memory-bank
263
280
 
264
- **HTTP Transport (REST API - Planned):**
265
- ```bash
266
- # Coming soon - not yet implemented
267
- python -m mcp_sqlite_memory_bank.server http --port 8000
281
+ # Force refresh to latest version
282
+ uvx --refresh mcp-sqlite-memory-bank
268
283
  ```
269
284
 
270
- **Streamable HTTP Transport (Latest MCP Spec - Planned):**
271
- ```bash
272
- # Coming soon - not yet implemented
273
- python -m mcp_sqlite_memory_bank.server streamable-http --port 8000
274
- ```
285
+ ### Development/Testing Modes
275
286
 
276
- **With the example runner:**
287
+ **HTTP Server Mode (for development and testing):**
277
288
  ```bash
278
- python examples/run_server.py
289
+ python -m mcp_sqlite_memory_bank.server main --port 8000
279
290
  ```
280
291
 
281
- **With FastMCP (Planned):**
292
+ **Direct Python Module:**
282
293
  ```bash
283
- # Coming soon - not yet implemented
284
- fastmcp install mcp_sqlite_memory_bank/server.py --name "SQLite Memory Bank"
294
+ python -m mcp_sqlite_memory_bank.server
285
295
  ```
286
296
 
287
297
  ---
@@ -403,6 +413,43 @@ For a complete agent memory implementation example, see [examples/agent_memory_e
403
413
 
404
414
  ---
405
415
 
416
+ ## Troubleshooting
417
+
418
+ ### Common MCP Connection Issues
419
+
420
+ **Server not starting / Connection timeout:**
421
+ ```bash
422
+ # Force refresh uvx cache and try again
423
+ uvx --refresh mcp-sqlite-memory-bank
424
+
425
+ # Check if the command works directly
426
+ uvx mcp-sqlite-memory-bank --help
427
+ ```
428
+
429
+ **VS Code: "Server exited before responding to initialize request":**
430
+ 1. Check the MCP configuration in `.vscode/mcp.json`
431
+ 2. Ensure `uvx` is installed and in your PATH
432
+ 3. Try restarting VS Code or running "MCP: Restart Server" from Command Palette
433
+
434
+ **Tools not appearing in IDE:**
435
+ 1. Verify the server is running: `uvx mcp-sqlite-memory-bank` should start without errors
436
+ 2. Check that `"type": "stdio"` is set in your MCP configuration
437
+ 3. Restart your IDE or reload MCP configuration
438
+
439
+ **Database permission errors:**
440
+ - Ensure the directory for `DB_PATH` exists and is writable
441
+ - Check file permissions on the SQLite database file
442
+ - Use absolute paths in `DB_PATH` to avoid path resolution issues
443
+
444
+ **Package not found / outdated version:**
445
+ ```bash
446
+ # Clear uvx cache completely
447
+ uvx cache remove mcp-sqlite-memory-bank
448
+ uvx mcp-sqlite-memory-bank
449
+ ```
450
+
451
+ ---
452
+
406
453
 
407
454
  ## Running Tests
408
455