db-connect-mcp 0.1.4__py3-none-any.whl → 0.1.5__py3-none-any.whl

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.

Potentially problematic release.


This version of db-connect-mcp might be problematic. Click here for more details.

@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: db-connect-mcp
3
- Version: 0.1.4
3
+ Version: 0.1.5
4
4
  Summary: Multi-database MCP server for PostgreSQL, MySQL, and ClickHouse
5
5
  Project-URL: Homepage, https://github.com/yugui923/db-connect-mcp
6
6
  Project-URL: Repository, https://github.com/yugui923/db-connect-mcp
@@ -38,29 +38,16 @@ A read-only MCP (Model Context Protocol) server for exploratory data analysis ac
38
38
 
39
39
  1. **Install:**
40
40
  ```bash
41
- # Option 1: From PyPI (recommended)
42
41
  pip install db-connect-mcp
43
-
44
- # Option 2: From source
45
- git clone https://github.com/yugui923/db-connect-mcp.git
46
- cd db-connect-mcp
47
- uv sync
48
- ```
49
-
50
- 2. **Configure** `.env`:
51
- ```env
52
- DATABASE_URL=postgres://user:pass@localhost:5432/mydb
53
- # Also supports: postgresql://, pg://, jdbc:postgresql://
54
- # MariaDB: mariadb://, jdbc:mysql://, jdbc:mariadb://
55
- # ClickHouse: ch://, jdbc:clickhouse://
56
42
  ```
57
43
 
58
- 3. **Add to Claude Desktop** `claude_desktop_config.json`:
44
+ 2. **Add to Claude Desktop** `claude_desktop_config.json`:
59
45
  ```json
60
46
  {
61
47
  "mcpServers": {
62
48
  "db-connect": {
63
- "command": "db-connect-mcp",
49
+ "command": "python",
50
+ "args": ["-m", "db_connect_mcp"],
64
51
  "env": {
65
52
  "DATABASE_URL": "postgresql://user:pass@localhost:5432/mydb"
66
53
  }
@@ -69,7 +56,9 @@ A read-only MCP (Model Context Protocol) server for exploratory data analysis ac
69
56
  }
70
57
  ```
71
58
 
72
- 4. **Restart Claude Desktop** and start querying your database!
59
+ 3. **Restart Claude Desktop** and start querying your database!
60
+
61
+ > **Note**: Using `python -m db_connect_mcp` ensures the command works even if Python's Scripts directory isn't in your PATH.
73
62
 
74
63
  ## Features
75
64
 
@@ -104,48 +93,18 @@ A read-only MCP (Model Context Protocol) server for exploratory data analysis ac
104
93
  ## Installation
105
94
 
106
95
  ### Prerequisites
107
- - Python 3.10 or higher
108
- - One or more of:
109
- - PostgreSQL database (9.6+)
110
- - MySQL/MariaDB database (5.7+/10.2+)
111
- - ClickHouse database
96
+ - **Python 3.10 or higher**
97
+ - **A database**: PostgreSQL (9.6+), MySQL/MariaDB (5.7+/10.2+), or ClickHouse
112
98
 
113
- ### Method 1: Install from PyPI (Recommended)
99
+ ### Install via pip
114
100
 
115
101
  ```bash
116
102
  pip install db-connect-mcp
117
103
  ```
118
104
 
119
- ### Method 2: Install from Source
120
-
121
- For development or the latest features:
122
-
123
- ```bash
124
- # Clone the repository
125
- git clone https://github.com/yugui923/db-connect-mcp.git
126
- cd db-connect-mcp
127
-
128
- # Install with uv (recommended)
129
- uv sync
130
-
131
- # Or install with pip
132
- pip install -e .
133
- ```
134
-
135
- ### Method 3: Install from GitHub
136
-
137
- ```bash
138
- pip install git+https://github.com/yugui923/db-connect-mcp.git
139
- ```
140
-
141
- ### Configuration
142
-
143
- After installation, configure your database connection:
105
+ That's it! The package is now ready to use.
144
106
 
145
- ```bash
146
- cp .env.example .env
147
- # Edit .env with your database connection string
148
- ```
107
+ > **For developers**: See [Development Guide](docs/DEVELOPMENT.md) for setting up a development environment.
149
108
 
150
109
  ## Configuration
151
110
 
@@ -267,41 +226,20 @@ DATABASE_URL=ch://user:pass@host:9000/db?timeout=60&max_threads=4
267
226
 
268
227
  ### Running the Server
269
228
 
270
- If installed from PyPI:
271
- ```bash
272
- db-connect-mcp
273
- ```
274
-
275
- If running from source (development):
276
229
  ```bash
277
- # Using module approach (recommended)
230
+ # Run the server (works everywhere, no PATH configuration needed)
278
231
  python -m db_connect_mcp
279
232
 
280
- # Or using uv
281
- uv run db-connect-mcp
233
+ # With environment variable
234
+ DATABASE_URL="postgresql://user:pass@host:5432/db" python -m db_connect_mcp
282
235
  ```
283
236
 
237
+ > **Note**: Using `python -m db_connect_mcp` works regardless of whether Python's Scripts directory is in your PATH.
238
+
284
239
  ### Using with Claude Desktop
285
240
 
286
241
  Add the server to your Claude Desktop configuration (`claude_desktop_config.json`):
287
242
 
288
- #### If installed from PyPI:
289
-
290
- ```json
291
- {
292
- "mcpServers": {
293
- "db-connect": {
294
- "command": "db-connect-mcp",
295
- "env": {
296
- "DATABASE_URL": "postgresql+asyncpg://user:pass@host:5432/db"
297
- }
298
- }
299
- }
300
- }
301
- ```
302
-
303
- #### If running from source (development):
304
-
305
243
  ```json
306
244
  {
307
245
  "mcpServers": {
@@ -316,34 +254,21 @@ Add the server to your Claude Desktop configuration (`claude_desktop_config.json
316
254
  }
317
255
  ```
318
256
 
319
- #### Or using uv (for development with dependencies):
257
+ **Multiple database connections:**
320
258
 
321
- ```json
322
- {
323
- "mcpServers": {
324
- "db-connect": {
325
- "command": "uv",
326
- "args": ["--directory", "C:/path/to/db-connect-mcp", "run", "db-connect-mcp"],
327
- "env": {
328
- "DATABASE_URL": "mysql+aiomysql://user:pass@host:3306/db"
329
- }
330
- }
331
- }
332
- }
333
- ```
334
-
335
- You can configure multiple database connections:
336
259
  ```json
337
260
  {
338
261
  "mcpServers": {
339
262
  "postgres-prod": {
340
- "command": "db-connect-mcp",
263
+ "command": "python",
264
+ "args": ["-m", "db_connect_mcp"],
341
265
  "env": {
342
266
  "DATABASE_URL": "postgresql+asyncpg://user:pass@pg-host:5432/db"
343
267
  }
344
268
  },
345
269
  "mysql-analytics": {
346
- "command": "db-connect-mcp",
270
+ "command": "python",
271
+ "args": ["-m", "db_connect_mcp"],
347
272
  "env": {
348
273
  "DATABASE_URL": "mysql+aiomysql://user:pass@mysql-host:3306/analytics"
349
274
  }
@@ -352,6 +277,8 @@ You can configure multiple database connections:
352
277
  }
353
278
  ```
354
279
 
280
+ > **For development**: See [Development Guide](docs/DEVELOPMENT.md) for running from source with uv.
281
+
355
282
  ## Database Feature Support
356
283
 
357
284
  | Feature | PostgreSQL | MySQL | ClickHouse |
@@ -465,6 +392,8 @@ Once configured, you can use the server in Claude:
465
392
 
466
393
  ## Development
467
394
 
395
+ For detailed development setup, testing, and contribution guidelines, see the [Development Guide](docs/DEVELOPMENT.md).
396
+
468
397
  ### Project Structure
469
398
  ```
470
399
  db-connect-mcp/
@@ -512,13 +441,8 @@ The server uses an adapter pattern to support multiple database systems:
512
441
  - **Server**: MCP server implementation that routes requests to appropriate components
513
442
 
514
443
  ### Running Tests
515
- ```bash
516
- # Run integration tests
517
- uv run python tests/test_server.py
518
444
 
519
- # Or with pytest (when available)
520
- uv run pytest tests/
521
- ```
445
+ See the [Development Guide](docs/DEVELOPMENT.md#running-tests) and [Test Guide](tests/README.md) for detailed testing instructions.
522
446
 
523
447
  ## Troubleshooting
524
448
 
@@ -18,8 +18,8 @@ db_connect_mcp/models/database.py,sha256=MEg5pimkkvMhdre7u2oVWRyuaJToja26Rjro-QC
18
18
  db_connect_mcp/models/query.py,sha256=FazyV6pWEJFUDlYPswOmCGJTUgT14f9xfzQHZhxh9n0,4398
19
19
  db_connect_mcp/models/statistics.py,sha256=ii_UqybC9L5P1DF4KN0XOnG49s4cmYlOdWDAdkVhqUc,6208
20
20
  db_connect_mcp/models/table.py,sha256=v1HhItb2UqS9QpAfMgDoDyU_6xDgvy4r3BlEE7QliSs,8445
21
- db_connect_mcp-0.1.4.dist-info/METADATA,sha256=son3d_gmNkbxQkG4RERvQGwBBAf_q5FNcywFQ5NQWEA,18351
22
- db_connect_mcp-0.1.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
23
- db_connect_mcp-0.1.4.dist-info/entry_points.txt,sha256=KjyjOdBJEFQutb9nB9Zvjc9XdjQ81O6H88r-Nb9vKGY,67
24
- db_connect_mcp-0.1.4.dist-info/licenses/LICENSE,sha256=c71UYlLh5ubuIlgVlM3EMkFdhWxTIULtUx_a8KOhI8w,1065
25
- db_connect_mcp-0.1.4.dist-info/RECORD,,
21
+ db_connect_mcp-0.1.5.dist-info/METADATA,sha256=_zN7lVDADM5Ho6G1bDK4n0F2_qheVaocTfsBYGQUgzg,17474
22
+ db_connect_mcp-0.1.5.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
23
+ db_connect_mcp-0.1.5.dist-info/entry_points.txt,sha256=KjyjOdBJEFQutb9nB9Zvjc9XdjQ81O6H88r-Nb9vKGY,67
24
+ db_connect_mcp-0.1.5.dist-info/licenses/LICENSE,sha256=c71UYlLh5ubuIlgVlM3EMkFdhWxTIULtUx_a8KOhI8w,1065
25
+ db_connect_mcp-0.1.5.dist-info/RECORD,,