mcp-dbutils 0.8.0__tar.gz → 0.9.0__tar.gz

{mcp_dbutils-0.8.0 → mcp_dbutils-0.9.0}/CHANGELOG.md

@@ -1,12 +1,91 @@
 # CHANGELOG
 
 
+## v0.9.0 (2025-03-09)
+
+### Documentation
+
+- Update README files to include new tools
+  ([`eb796d5`](https://github.com/donghao1393/mcp-dbutils/commit/eb796d54ca517c173e26b8a535bfeb00545fbab0))
+
+Added documentation for new tools: - dbutils-get-stats - dbutils-list-constraints -
+  dbutils-explain-query
+
+Both English and Chinese READMEs updated
+
+- Update README files with new monitoring tools
+  ([#18](https://github.com/donghao1393/mcp-dbutils/pull/18),
+  [`4b919fe`](https://github.com/donghao1393/mcp-dbutils/commit/4b919fe348e2f6ed35ea1f16b64a2706a5d875f4))
+
+- Add dbutils-get-performance tool documentation - Add dbutils-analyze-query tool documentation -
+  Update both English and Chinese READMEs
+
+- Update tool names with dbutils prefix
+  ([`4731021`](https://github.com/donghao1393/mcp-dbutils/commit/4731021ab981ecca305414f34f72c1f8f0577b8e))
+
+Renamed basic tools in README files: - list_tables -> dbutils-list-tables - query -> dbutils-query
+
+Both English and Chinese READMEs updated
+
+### Features
+
+- Add advanced database tools ([#15](https://github.com/donghao1393/mcp-dbutils/pull/15),
+  [`2c85dc8`](https://github.com/donghao1393/mcp-dbutils/commit/2c85dc8c026bca93571ab8ed5b837518553087d5))
+
+* Added three new tools:
+
+1. dbutils-get-stats - Table statistics information - Column level statistics - Adapted for
+  PostgreSQL and SQLite
+
+2. dbutils-list-constraints - Primary key, foreign key, unique constraints - Constraint definitions
+  and properties - Constraint comments support
+
+3. dbutils-explain-query - EXPLAIN and EXPLAIN ANALYZE support - Detailed cost and timing estimates
+  - Database-specific optimizations
+
+Implementation: - Added abstract methods to DatabaseHandler - Implemented in PostgreSQL and SQLite -
+  Added dedicated integration tests - Fixed SQL syntax and parameter issues
+
+Refs #14
+
+* fix: check non-SELECT statements in SQLite handler
+
+- Add more database tools ([#13](https://github.com/donghao1393/mcp-dbutils/pull/13),
+  [`8b8bd1e`](https://github.com/donghao1393/mcp-dbutils/commit/8b8bd1ea04d63e7828c81dc25a9c0cb70df73867))
+
+* 添加更多数据库工具
+
+添加三个新的数据库工具： - dbutils-describe-table：获取表的详细信息 - dbutils-get-ddl：获取表的DDL语句 -
+  dbutils-list-indexes：获取表的索引信息
+
+实现内容： - DatabaseHandler新增三个抽象方法 - PostgreSQL和SQLite分别实现这些方法 - 添加新工具的集成测试 - 所有测试通过
+
+Fixes #12
+
+* test: 拆分表信息工具测试
+
+将test_table_info_tools拆分为三个独立的测试函数： - test_describe_table_tool - test_get_ddl_tool -
+  test_list_indexes_tool
+
+这样可以更清晰地展示每个工具的测试状态，便于定位问题。
+
+- Enhance monitoring system with LLM dialog support
+  ([#17](https://github.com/donghao1393/mcp-dbutils/pull/17),
+  [`50d8df1`](https://github.com/donghao1393/mcp-dbutils/commit/50d8df1fabbf6513718582e6efe0d3832de9ce5d))
+
+- Add query duration tracking - Add query type statistics - Add slow query detection - Add memory
+  usage tracking - Add performance statistics formatting - Add new MCP tools:
+  dbutils-get-performance and dbutils-analyze-query - Add tests for new features
+
+Closes #16
+
+
 ## v0.8.0 (2025-03-09)
 
 ### Features
 
 - Unify tool names with dbutils prefix ([#11](https://github.com/donghao1393/mcp-dbutils/pull/11),
-  [`30ebbc2`](https://github.com/donghao1393/mcp-dbutils/commit/30ebbc251be55f7d18fc9873021151b82c3f0fde))
+  [`aa57995`](https://github.com/donghao1393/mcp-dbutils/commit/aa57995dc6cf3ffd33909162d831dffbbbf19bfc))
 
 给工具名称添加dbutils前缀，使所有工具名称规范统一： - query -> dbutils-run-query - list_tables -> dbutils-list-tables
 

{mcp_dbutils-0.8.0 → mcp_dbutils-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcp-dbutils
-Version: 0.8.0
+Version: 0.9.0
 Summary: MCP Database Utilities Service
 Author: Dong Hao
 License-Expression: MIT
@@ -148,7 +148,7 @@ Add to Claude configuration:
 The project requires a YAML configuration file, specified via the `--config` parameter. Configuration example:
 
 ```yaml
-databases:
+connections:
   # Standard PostgreSQL configuration example
   my_postgres:
     type: postgres
@@ -257,7 +257,7 @@ The abstraction layer design is the core architectural concept in MCP Database U
 
 ### Basic Query
 ```python
-# Access through database name
+# Access through connection name
 async with server.get_handler("my_postgres") as handler:
     # Execute SQL query
     result = await handler.execute_query("SELECT * FROM users")
@@ -275,7 +275,7 @@ schema = await handler.get_schema("users")
 ### Error Handling
 ```python
 try:
-    async with server.get_handler("my_db") as handler:
+    async with server.get_handler("my_connection") as handler:
         result = await handler.execute_query("SELECT * FROM users")
 except ValueError as e:
     print(f"Configuration error: {e}")
@@ -298,19 +298,53 @@ Core server class providing:
 
 ### MCP Tools
 
-#### list_tables
+#### dbutils-list-tables
 Lists all tables in the specified database.
 - Parameters:
-  * database: Database configuration name
+  * connection: Database connection name
 - Returns: Text content with a list of table names
 
-#### query
+#### dbutils-run-query
 Executes a SQL query on the specified database.
 - Parameters:
-  * database: Database configuration name
+  * connection: Database connection name
   * sql: SQL query to execute (SELECT only)
 - Returns: Query results in a formatted text
 
+#### dbutils-get-stats
+Get table statistics information.
+- Parameters:
+  * connection: Database connection name
+  * table: Table name
+- Returns: Statistics including row count, size, column stats
+
+#### dbutils-list-constraints
+List table constraints (primary key, foreign keys, etc).
+- Parameters:
+  * connection: Database connection name
+  * table: Table name
+- Returns: Detailed constraint information
+
+#### dbutils-explain-query
+Get query execution plan with cost estimates.
+- Parameters:
+  * connection: Database connection name
+  * sql: SQL query to explain
+- Returns: Formatted execution plan
+
+#### dbutils-get-performance
+Get database performance statistics.
+- Parameters:
+  * connection: Database connection name
+- Returns: Detailed performance statistics including query times, query types, error rates, and resource usage
+
+#### dbutils-analyze-query
+Analyze a SQL query for performance and provide optimization suggestions.
+- Parameters:
+  * connection: Database connection name
+  * sql: SQL query to analyze
+- Returns: Query analysis with execution plan, timing information, and optimization suggestions
+
 ### DatabaseHandler
 Abstract base class defining interfaces:
 - get_tables(): Get table resource list

{mcp_dbutils-0.8.0 → mcp_dbutils-0.9.0}/README.md

@@ -126,7 +126,7 @@ Add to Claude configuration:
 The project requires a YAML configuration file, specified via the `--config` parameter. Configuration example:
 
 ```yaml
-databases:
+connections:
   # Standard PostgreSQL configuration example
   my_postgres:
     type: postgres
@@ -235,7 +235,7 @@ The abstraction layer design is the core architectural concept in MCP Database U
 
 ### Basic Query
 ```python
-# Access through database name
+# Access through connection name
 async with server.get_handler("my_postgres") as handler:
     # Execute SQL query
     result = await handler.execute_query("SELECT * FROM users")
@@ -253,7 +253,7 @@ schema = await handler.get_schema("users")
 ### Error Handling
 ```python
 try:
-    async with server.get_handler("my_db") as handler:
+    async with server.get_handler("my_connection") as handler:
         result = await handler.execute_query("SELECT * FROM users")
 except ValueError as e:
     print(f"Configuration error: {e}")
@@ -276,19 +276,53 @@ Core server class providing:
 
 ### MCP Tools
 
-#### list_tables
+#### dbutils-list-tables
 Lists all tables in the specified database.
 - Parameters:
-  * database: Database configuration name
+  * connection: Database connection name
 - Returns: Text content with a list of table names
 
-#### query
+#### dbutils-run-query
 Executes a SQL query on the specified database.
 - Parameters:
-  * database: Database configuration name
+  * connection: Database connection name
   * sql: SQL query to execute (SELECT only)
 - Returns: Query results in a formatted text
 
+#### dbutils-get-stats
+Get table statistics information.
+- Parameters:
+  * connection: Database connection name
+  * table: Table name
+- Returns: Statistics including row count, size, column stats
+
+#### dbutils-list-constraints
+List table constraints (primary key, foreign keys, etc).
+- Parameters:
+  * connection: Database connection name
+  * table: Table name
+- Returns: Detailed constraint information
+
+#### dbutils-explain-query
+Get query execution plan with cost estimates.
+- Parameters:
+  * connection: Database connection name
+  * sql: SQL query to explain
+- Returns: Formatted execution plan
+
+#### dbutils-get-performance
+Get database performance statistics.
+- Parameters:
+  * connection: Database connection name
+- Returns: Detailed performance statistics including query times, query types, error rates, and resource usage
+
+#### dbutils-analyze-query
+Analyze a SQL query for performance and provide optimization suggestions.
+- Parameters:
+  * connection: Database connection name
+  * sql: SQL query to analyze
+- Returns: Query analysis with execution plan, timing information, and optimization suggestions
+
 ### DatabaseHandler
 Abstract base class defining interfaces:
 - get_tables(): Get table resource list

{mcp_dbutils-0.8.0 → mcp_dbutils-0.9.0}/README_CN.md

@@ -110,7 +110,7 @@ docker run -i --rm \
 项目运行需要一个YAML格式的配置文件，通过 `--config` 参数指定路径。配置示例：
 
 ```yaml
-databases:
+connections:
   # PostgreSQL标准配置示例
   my_postgres:
     type: postgres
@@ -219,7 +219,7 @@ graph TD
 
 ### 基本查询
 ```python
-# 通过数据库名称访问
+# 通过连接名称访问
 async with server.get_handler("my_postgres") as handler:
     # 执行SQL查询
     result = await handler.execute_query("SELECT * FROM users")
@@ -237,7 +237,7 @@ schema = await handler.get_schema("users")
 ### 错误处理
 ```python
 try:
-    async with server.get_handler("my_db") as handler:
+    async with server.get_handler("my_connection") as handler:
         result = await handler.execute_query("SELECT * FROM users")
 except ValueError as e:
     print(f"配置错误: {e}")
@@ -260,19 +260,53 @@ except Exception as e:
 
 ### MCP工具
 
-#### list_tables
+#### dbutils-list-tables
 列出指定数据库中的所有表。
 - 参数：
-  * database: 数据库配置名称
+  * connection: 数据库连接名称
 - 返回：包含表名列表的文本内容
 
-#### query
+#### dbutils-run-query
 在指定数据库上执行SQL查询。
 - 参数：
-  * database: 数据库配置名称
+  * connection: 数据库连接名称
   * sql: 要执行的SQL查询（仅支持SELECT）
 - 返回：格式化的查询结果文本
 
+#### dbutils-get-stats
+获取表的统计信息。
+- 参数：
+  * connection: 数据库连接名称
+  * table: 表名
+- 返回：包括行数、大小、列统计等信息
+
+#### dbutils-list-constraints
+列出表的约束信息（主键、外键等）。
+- 参数：
+  * connection: 数据库连接名称
+  * table: 表名
+- 返回：详细的约束信息
+
+#### dbutils-explain-query
+获取查询的执行计划和成本估算。
+- 参数：
+  * connection: 数据库连接名称
+  * sql: 要分析的SQL查询
+- 返回：格式化的执行计划
+
+#### dbutils-get-performance
+获取数据库性能统计信息。
+- 参数：
+  * connection: 数据库连接名称
+- 返回：详细的性能统计信息，包括查询时间、查询类型、错误率和资源使用情况
+
+#### dbutils-analyze-query
+分析SQL查询的性能并提供优化建议。
+- 参数：
+  * connection: 数据库连接名称
+  * sql: 要分析的SQL查询
+- 返回：查询分析结果，包括执行计划、时间信息和优化建议
+
 ### DatabaseHandler
 抽象基类，定义接口:
 - get_tables(): 获取表资源列表

{mcp_dbutils-0.8.0 → mcp_dbutils-0.9.0}/config.yaml.example

@@ -1,4 +1,4 @@
-databases:
+connections:
   # SQLite configuration examples
   # SQLite with standard configuration
   dev-db:

{mcp_dbutils-0.8.0 → mcp_dbutils-0.9.0}/pyproject.toml

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

{mcp_dbutils-0.8.0 → mcp_dbutils-0.9.0}/src/mcp_dbutils/__init__.py

@@ -1,4 +1,4 @@
-"""MCP Database Utilities Service"""
+"""MCP Connection Utilities Service"""
 
 import asyncio
 import argparse
@@ -9,7 +9,7 @@ import yaml
 from importlib.metadata import metadata
 
 from .log import create_logger
-from .base import DatabaseServer
+from .base import ConnectionServer
 
 # 获取包信息
 pkg_meta = metadata("mcp-dbutils")
@@ -19,7 +19,7 @@ log = create_logger(pkg_meta["Name"])
 
 async def run_server():
     """服务器运行逻辑"""
-    parser = argparse.ArgumentParser(description='MCP Database Server')
+    parser = argparse.ArgumentParser(description='MCP Connection Server')
     parser.add_argument('--config', required=True, help='YAML配置文件路径')
     parser.add_argument('--local-host', help='本地主机地址')
 
@@ -32,7 +32,7 @@ async def run_server():
     global log
     log = create_logger(pkg_meta["Name"], debug)
 
-    log("info", f"MCP Database Utilities Service v{pkg_meta['Version']}")
+    log("info", f"MCP Connection Utilities Service v{pkg_meta['Version']}")
     if debug:
         log("debug", "Debug模式已开启")
 
@@ -40,11 +40,11 @@ async def run_server():
     try:
         with open(args.config, 'r') as f:
             config = yaml.safe_load(f)
-            if not config or 'databases' not in config:
-                log("error", "配置文件必须包含 databases 配置")
+            if not config or 'connections' not in config:
+                log("error", "配置文件必须包含 connections 配置")
                 sys.exit(1)
-            if not config['databases']:
-                log("error", "配置文件必须包含至少一个数据库配置")
+            if not config['connections']:
+                log("error", "配置文件必须包含至少一个连接配置")
                 sys.exit(1)
     except Exception as e:
         log("error", f"读取配置文件失败: {str(e)}")
@@ -52,7 +52,7 @@ async def run_server():
 
     # 创建并运行服务器
     try:
-        server = DatabaseServer(args.config, debug)
+        server = ConnectionServer(args.config, debug)
         await server.run()
     except KeyboardInterrupt:
         log("info", "服务器已停止")