mcp-dbutils 0.2.3__tar.gz → 0.2.4__tar.gz

{mcp_dbutils-0.2.3 → mcp_dbutils-0.2.4}/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.2.4] - 2025-02-09
+
+### Changed
+- Unified server configuration name to "dbutils"
+- Improved documentation formatting and readability
+- Added architecture diagrams
+- Added contribution guidelines
+- Enhanced installation instructions with environment variables
+- Added acknowledgments section
+
 ## [0.2.3] - 2025-02-09
 
 ### Added

{mcp_dbutils-0.2.3 → mcp_dbutils-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcp-dbutils
-Version: 0.2.3
+Version: 0.2.4
 Summary: MCP Database Utilities Service
 Author: Dong Hao
 License-Expression: MIT
@@ -16,7 +16,7 @@ Description-Content-Type: text/markdown
 
 ![GitHub Repo stars](https://img.shields.io/github/stars/donghao1393/mcp-dbutils)
 ![PyPI version](https://img.shields.io/pypi/v/mcp-dbutils)
-![Python versions](https://img.shields.io/pypi/pyversions/mcp-dbutils)
+![Python](https://img.shields.io/badge/Python-3.10%2B-blue)
 ![License](https://img.shields.io/github/license/donghao1393/mcp-dbutils)
 
 [中文文档](README_CN.md)
@@ -45,9 +45,16 @@ uvx mcp-dbutils --config /path/to/config.yaml
 Add to Claude configuration:
 ```json
 "mcpServers": {
-  "database": {
+  "dbutils": {
     "command": "uvx",
-    "args": ["mcp-dbutils", "--config", "/path/to/config.yaml"]
+    "args": [
+      "mcp-dbutils",
+      "--config",
+      "/path/to/config.yaml"
+    ],
+    "env": {
+      "MCP_DEBUG": "1"  // Optional: Enable debug mode
+    }
   }
 }
 ```
@@ -60,9 +67,17 @@ pip install mcp-dbutils
 Add to Claude configuration:
 ```json
 "mcpServers": {
-  "database": {
+  "dbutils": {
     "command": "python",
-    "args": ["-m", "mcp_dbutils", "--config", "/path/to/config.yaml"]
+    "args": [
+      "-m",
+      "mcp_dbutils",
+      "--config",
+      "/path/to/config.yaml"
+    ],
+    "env": {
+      "MCP_DEBUG": "1"  // Optional: Enable debug mode
+    }
   }
 }
 ```
@@ -71,16 +86,28 @@ Add to Claude configuration:
 ```bash
 docker run -i --rm \
   -v /path/to/config.yaml:/app/config.yaml \
+  -e MCP_DEBUG=1 \  # Optional: Enable debug mode
   mcp/dbutils --config /app/config.yaml
 ```
 
 Add to Claude configuration:
 ```json
 "mcpServers": {
-  "database": {
+  "dbutils": {
     "command": "docker",
-    "args": ["run", "-i", "--rm", "-v", "/path/to/config.yaml:/app/config.yaml", 
-             "mcp/dbutils", "--config", "/app/config.yaml"]
+    "args": [
+      "run",
+      "-i",
+      "--rm",
+      "-v",
+      "/path/to/config.yaml:/app/config.yaml",
+      "mcp/dbutils",
+      "--config",
+      "/app/config.yaml"
+    ],
+    "env": {
+      "MCP_DEBUG": "1"  // Optional: Enable debug mode
+    }
   }
 }
 ```
@@ -117,6 +144,23 @@ Set environment variable `MCP_DEBUG=1` to enable debug mode for detailed logging
 ## Architecture Design
 
 ### Core Concept: Abstraction Layer
+
+```mermaid
+graph TD
+  Client[Client] --> DatabaseServer[Database Server]
+  subgraph MCP Server
+    DatabaseServer
+    DatabaseHandler[Database Handler]
+    PostgresHandler[PostgreSQL Handler]
+    SQLiteHandler[SQLite Handler]
+    DatabaseServer --> DatabaseHandler
+    DatabaseHandler --> PostgresHandler
+    DatabaseHandler --> SQLiteHandler
+  end
+  PostgresHandler --> PostgreSQL[(PostgreSQL)]
+  SQLiteHandler --> SQLite[(SQLite)]
+```
+
 The abstraction layer design is the core architectural concept in MCP Database Utilities. Just like a universal remote control that works with different devices, users only need to know the basic operations without understanding the underlying complexities.
 
 #### 1. Simplified User Interaction
@@ -216,3 +260,26 @@ Provides SQLite-specific features:
 - File path handling
 - URI scheme support
 - Password protection support (optional)
+
+## Contributing
+Contributions are welcome! Here's how you can help:
+
+1. 🐛 Report bugs: Open an issue describing the bug and how to reproduce it
+2. 💡 Suggest features: Open an issue to propose new features
+3. 🛠️ Submit PRs: Fork the repo and create a pull request with your changes
+
+### Development Setup
+1. Clone the repository
+2. Create a virtual environment using `uv venv`
+3. Install dependencies with `uv sync --all-extras`
+4. Run tests with `pytest`
+
+For detailed guidelines, see [CONTRIBUTING.md](.github/CONTRIBUTING.md)
+
+## Acknowledgments
+- [MCP Servers](https://github.com/modelcontextprotocol/servers) for inspiration and demonstration
+- AI Editors:
+  * [Claude Desktop](https://claude.ai/download)
+  * [5ire](https://5ire.app/)
+  * [Cline](https://cline.bot)
+- [Model Context Protocol](https://modelcontextprotocol.io/) for comprehensive interfaces

{mcp_dbutils-0.2.3 → mcp_dbutils-0.2.4}/README.md

@@ -2,7 +2,7 @@
 
 ![GitHub Repo stars](https://img.shields.io/github/stars/donghao1393/mcp-dbutils)
 ![PyPI version](https://img.shields.io/pypi/v/mcp-dbutils)
-![Python versions](https://img.shields.io/pypi/pyversions/mcp-dbutils)
+![Python](https://img.shields.io/badge/Python-3.10%2B-blue)
 ![License](https://img.shields.io/github/license/donghao1393/mcp-dbutils)
 
 [中文文档](README_CN.md)
@@ -31,9 +31,16 @@ uvx mcp-dbutils --config /path/to/config.yaml
 Add to Claude configuration:
 ```json
 "mcpServers": {
-  "database": {
+  "dbutils": {
     "command": "uvx",
-    "args": ["mcp-dbutils", "--config", "/path/to/config.yaml"]
+    "args": [
+      "mcp-dbutils",
+      "--config",
+      "/path/to/config.yaml"
+    ],
+    "env": {
+      "MCP_DEBUG": "1"  // Optional: Enable debug mode
+    }
   }
 }
 ```
@@ -46,9 +53,17 @@ pip install mcp-dbutils
 Add to Claude configuration:
 ```json
 "mcpServers": {
-  "database": {
+  "dbutils": {
     "command": "python",
-    "args": ["-m", "mcp_dbutils", "--config", "/path/to/config.yaml"]
+    "args": [
+      "-m",
+      "mcp_dbutils",
+      "--config",
+      "/path/to/config.yaml"
+    ],
+    "env": {
+      "MCP_DEBUG": "1"  // Optional: Enable debug mode
+    }
   }
 }
 ```
@@ -57,16 +72,28 @@ Add to Claude configuration:
 ```bash
 docker run -i --rm \
   -v /path/to/config.yaml:/app/config.yaml \
+  -e MCP_DEBUG=1 \  # Optional: Enable debug mode
   mcp/dbutils --config /app/config.yaml
 ```
 
 Add to Claude configuration:
 ```json
 "mcpServers": {
-  "database": {
+  "dbutils": {
     "command": "docker",
-    "args": ["run", "-i", "--rm", "-v", "/path/to/config.yaml:/app/config.yaml", 
-             "mcp/dbutils", "--config", "/app/config.yaml"]
+    "args": [
+      "run",
+      "-i",
+      "--rm",
+      "-v",
+      "/path/to/config.yaml:/app/config.yaml",
+      "mcp/dbutils",
+      "--config",
+      "/app/config.yaml"
+    ],
+    "env": {
+      "MCP_DEBUG": "1"  // Optional: Enable debug mode
+    }
   }
 }
 ```
@@ -103,6 +130,23 @@ Set environment variable `MCP_DEBUG=1` to enable debug mode for detailed logging
 ## Architecture Design
 
 ### Core Concept: Abstraction Layer
+
+```mermaid
+graph TD
+  Client[Client] --> DatabaseServer[Database Server]
+  subgraph MCP Server
+    DatabaseServer
+    DatabaseHandler[Database Handler]
+    PostgresHandler[PostgreSQL Handler]
+    SQLiteHandler[SQLite Handler]
+    DatabaseServer --> DatabaseHandler
+    DatabaseHandler --> PostgresHandler
+    DatabaseHandler --> SQLiteHandler
+  end
+  PostgresHandler --> PostgreSQL[(PostgreSQL)]
+  SQLiteHandler --> SQLite[(SQLite)]
+```
+
 The abstraction layer design is the core architectural concept in MCP Database Utilities. Just like a universal remote control that works with different devices, users only need to know the basic operations without understanding the underlying complexities.
 
 #### 1. Simplified User Interaction
@@ -202,3 +246,26 @@ Provides SQLite-specific features:
 - File path handling
 - URI scheme support
 - Password protection support (optional)
+
+## Contributing
+Contributions are welcome! Here's how you can help:
+
+1. 🐛 Report bugs: Open an issue describing the bug and how to reproduce it
+2. 💡 Suggest features: Open an issue to propose new features
+3. 🛠️ Submit PRs: Fork the repo and create a pull request with your changes
+
+### Development Setup
+1. Clone the repository
+2. Create a virtual environment using `uv venv`
+3. Install dependencies with `uv sync --all-extras`
+4. Run tests with `pytest`
+
+For detailed guidelines, see [CONTRIBUTING.md](.github/CONTRIBUTING.md)
+
+## Acknowledgments
+- [MCP Servers](https://github.com/modelcontextprotocol/servers) for inspiration and demonstration
+- AI Editors:
+  * [Claude Desktop](https://claude.ai/download)
+  * [5ire](https://5ire.app/)
+  * [Cline](https://cline.bot)
+- [Model Context Protocol](https://modelcontextprotocol.io/) for comprehensive interfaces

{mcp_dbutils-0.2.3 → mcp_dbutils-0.2.4}/README_CN.md

@@ -24,9 +24,16 @@ uvx mcp-dbutils --config /path/to/config.yaml
 添加到 Claude 配置：
 ```json
 "mcpServers": {
-  "database": {
+  "dbutils": {
     "command": "uvx",
-    "args": ["mcp-dbutils", "--config", "/path/to/config.yaml"]
+    "args": [
+      "mcp-dbutils",
+      "--config",
+      "/path/to/config.yaml"
+    ],
+    "env": {
+      "MCP_DEBUG": "1"  // 可选：启用调试模式
+    }
   }
 }
 ```
@@ -39,9 +46,17 @@ pip install mcp-dbutils
 添加到 Claude 配置：
 ```json
 "mcpServers": {
-  "database": {
+  "dbutils": {
     "command": "python",
-    "args": ["-m", "mcp_dbutils", "--config", "/path/to/config.yaml"]
+    "args": [
+      "-m",
+      "mcp_dbutils",
+      "--config",
+      "/path/to/config.yaml"
+    ],
+    "env": {
+      "MCP_DEBUG": "1"  // 可选：启用调试模式
+    }
   }
 }
 ```
@@ -50,16 +65,28 @@ pip install mcp-dbutils
 ```bash
 docker run -i --rm \
   -v /path/to/config.yaml:/app/config.yaml \
+  -e MCP_DEBUG=1 \  # 可选：启用调试模式
   mcp/dbutils --config /app/config.yaml
 ```
 
 添加到 Claude 配置：
 ```json
 "mcpServers": {
-  "database": {
+  "dbutils": {
     "command": "docker",
-    "args": ["run", "-i", "--rm", "-v", "/path/to/config.yaml:/app/config.yaml", 
-             "mcp/dbutils", "--config", "/app/config.yaml"]
+    "args": [
+      "run",
+      "-i",
+      "--rm",
+      "-v",
+      "/path/to/config.yaml:/app/config.yaml",
+      "mcp/dbutils",
+      "--config",
+      "/app/config.yaml"
+    ],
+    "env": {
+      "MCP_DEBUG": "1"  // 可选：启用调试模式
+    }
   }
 }
 ```
@@ -96,6 +123,23 @@ databases:
 ## 架构设计
 
 ### 核心理念：抽象层设计
+
+```mermaid
+graph TD
+  Client[客户端] --> DatabaseServer[数据库服务器]
+  subgraph MCP服务器
+    DatabaseServer
+    DatabaseHandler[数据库处理器]
+    PostgresHandler[PostgreSQL处理器]
+    SQLiteHandler[SQLite处理器]
+    DatabaseServer --> DatabaseHandler
+    DatabaseHandler --> PostgresHandler
+    DatabaseHandler --> SQLiteHandler
+  end
+  PostgresHandler --> PostgreSQL[(PostgreSQL数据库)]
+  SQLiteHandler --> SQLite[(SQLite数据库)]
+```
+
 在MCP数据库服务中，抽象层设计是最核心的架构思想。它就像一个通用遥控器，不管是控制电视还是空调，用户只需要知道"按下按钮就能完成操作"。
 
 #### 1. 简化用户交互
@@ -195,3 +239,26 @@ except Exception as e:
 - 文件路径处理
 - URI模式支持
 - 密码保护支持（可选）
+
+## 参与贡献
+欢迎贡献！以下是参与项目的方式：
+
+1. 🐛 报告问题：创建 issue 描述bug和复现步骤
+2. 💡 提供建议：创建 issue 提出新功能建议
+3. 🛠️ 提交PR：fork仓库并创建包含您改动的pull request
+
+### 开发环境设置
+1. 克隆仓库
+2. 使用 `uv venv` 创建虚拟环境
+3. 使用 `uv sync --all-extras` 安装依赖
+4. 使用 `pytest` 运行测试
+
+详细指南请参见 [CONTRIBUTING.md](.github/CONTRIBUTING.md)
+
+## 致谢
+- 感谢 [MCP Servers](https://github.com/modelcontextprotocol/servers) 提供的启发和演示
+- AI编辑器支持：
+  * [Claude Desktop](https://claude.ai/download)
+  * [5ire](https://5ire.app/)
+  * [Cline](https://cline.bot)
+- 感谢 [Model Context Protocol](https://modelcontextprotocol.io/) 提供丰富的接口支持

{mcp_dbutils-0.2.3 → mcp_dbutils-0.2.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mcp-dbutils"
-version = "0.2.3"
+version = "0.2.4"
 description = "MCP Database Utilities Service"
 readme = "README.md"
 license = "MIT"