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

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

@@ -1,6 +1,38 @@
 # CHANGELOG
 
 
+## 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))
+
+给工具名称添加dbutils前缀，使所有工具名称规范统一： - query -> dbutils-run-query - list_tables -> dbutils-list-tables
+
+让工具名称更清晰地表明是属于dbutils的工具，避免与其他MCP服务的工具冲突。
+
+Fixes #11
+
+
+## v0.7.0 (2025-03-09)
+
+### Documentation
+
+- Update README with list_tables tool information
+  ([`f3a2592`](https://github.com/donghao1393/mcp-dbutils/commit/f3a259200bbf18aaebbf6d4511a18d35246f5044))
+
+### Features
+
+- Add database type prefix to list_tables tool response
+  ([#10](https://github.com/donghao1393/mcp-dbutils/pull/10),
+  [`e32ce1f`](https://github.com/donghao1393/mcp-dbutils/commit/e32ce1f2502f24d111643d7233f0fdd420238bd7))
+
+添加数据库类型前缀到list_tables工具的返回结果中，使LLM能够知道当前操作的数据库类型， 便于后续操作。格式与错误信息保持一致，使用[数据库类型]前缀。
+
+Fixes #9
+
+
 ## v0.6.0 (2025-03-08)
 
 ### Documentation

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcp-dbutils
-Version: 0.6.0
+Version: 0.8.0
 Summary: MCP Database Utilities Service
 Author: Dong Hao
 License-Expression: MIT
@@ -39,6 +39,7 @@ MCP Database Utilities is a unified database access service that supports multip
 - Support for multiple database configurations
 - Secure read-only query execution
 - Table structure and schema information retrieval
+- Database tables listing via MCP tools
 - Intelligent connection management and resource cleanup
 - Debug mode support
 
@@ -292,9 +293,24 @@ except Exception as e:
 ### DatabaseServer
 Core server class providing:
 - Resource list retrieval
-- Tool call handling
+- Tool call handling (list_tables, query)
 - Database handler management
 
+### MCP Tools
+
+#### list_tables
+Lists all tables in the specified database.
+- Parameters:
+  * database: Database configuration name
+- Returns: Text content with a list of table names
+
+#### query
+Executes a SQL query on the specified database.
+- Parameters:
+  * database: Database configuration name
+  * sql: SQL query to execute (SELECT only)
+- Returns: Query results in a formatted text
+
 ### DatabaseHandler
 Abstract base class defining interfaces:
 - get_tables(): Get table resource list

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

@@ -17,6 +17,7 @@ MCP Database Utilities is a unified database access service that supports multip
 - Support for multiple database configurations
 - Secure read-only query execution
 - Table structure and schema information retrieval
+- Database tables listing via MCP tools
 - Intelligent connection management and resource cleanup
 - Debug mode support
 
@@ -270,9 +271,24 @@ except Exception as e:
 ### DatabaseServer
 Core server class providing:
 - Resource list retrieval
-- Tool call handling
+- Tool call handling (list_tables, query)
 - Database handler management
 
+### MCP Tools
+
+#### list_tables
+Lists all tables in the specified database.
+- Parameters:
+  * database: Database configuration name
+- Returns: Text content with a list of table names
+
+#### query
+Executes a SQL query on the specified database.
+- Parameters:
+  * database: Database configuration name
+  * sql: SQL query to execute (SELECT only)
+- Returns: Query results in a formatted text
+
 ### DatabaseHandler
 Abstract base class defining interfaces:
 - get_tables(): Get table resource list

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

@@ -8,6 +8,7 @@ MCP数据库服务是一个统一的数据库访问服务，支持多种数据
 - 支持多个数据库配置
 - 安全的只读查询执行
 - 表结构和模式信息查询
+- 通过MCP工具列出数据库表
 - 智能的连接管理和资源清理
 - 支持调试模式
 
@@ -254,9 +255,24 @@ except Exception as e:
 ### DatabaseServer
 核心服务器类，提供:
 - 资源列表获取
-- 工具调用处理
+- 工具调用处理（list_tables、query）
 - 数据库处理器管理
 
+### MCP工具
+
+#### list_tables
+列出指定数据库中的所有表。
+- 参数：
+  * database: 数据库配置名称
+- 返回：包含表名列表的文本内容
+
+#### query
+在指定数据库上执行SQL查询。
+- 参数：
+  * database: 数据库配置名称
+  * sql: 要执行的SQL查询（仅支持SELECT）
+- 返回：格式化的查询结果文本
+
 ### DatabaseHandler
 抽象基类，定义接口:
 - get_tables(): 获取表资源列表

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

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

{mcp_dbutils-0.6.0 → mcp_dbutils-0.8.0}/src/mcp_dbutils/base.py

@@ -204,8 +204,8 @@ class DatabaseServer:
         async def handle_list_tools() -> list[types.Tool]:
             return [
                 types.Tool(
-                    name="query",
-                    description="Execute read-only SQL query",
+                    name="dbutils-run-query",
+                    description="Execute read-only SQL query on database",
                     inputSchema={
                         "type": "object",
                         "properties": {
@@ -222,7 +222,7 @@ class DatabaseServer:
                     }
                 ),
                 types.Tool(
-                    name="list_tables",
+                    name="dbutils-list-tables",
                     description="List all available tables in the specified database",
                     inputSchema={
                         "type": "object",
@@ -244,9 +244,13 @@ class DatabaseServer:
 
             database = arguments["database"]
 
-            if name == "list_tables":
+            if name == "dbutils-list-tables":
                 async with self.get_handler(database) as handler:
                     tables = await handler.get_tables()
+                    if not tables:
+                        # 空表列表的情况也返回数据库类型
+                        return [types.TextContent(type="text", text=f"[{handler.db_type}] No tables found")]
+                    
                     formatted_tables = "\n".join([
                         f"Table: {table.name}\n" +
                         f"URI: {table.uri}\n" +
@@ -254,8 +258,9 @@ class DatabaseServer:
                         "---"
                         for table in tables
                     ])
-                    return [types.TextContent(type="text", text=formatted_tables)]
-            elif name == "query":
+                    # 添加数据库类型前缀
+                    return [types.TextContent(type="text", text=f"[{handler.db_type}]\n{formatted_tables}")]
+            elif name == "dbutils-run-query":
                 sql = arguments.get("sql", "").strip()
                 if not sql:
                     raise ConfigurationError("SQL query cannot be empty")

{mcp_dbutils-0.6.0 → mcp_dbutils-0.8.0}/tests/integration/test_tools.py

@@ -43,19 +43,23 @@ async def test_list_tables_tool(postgres_db, sqlite_db, mcp_config):
                 # List available tools
                 response = await client.list_tools()
                 tool_names = [tool.name for tool in response.tools]
-                assert "list_tables" in tool_names
-                assert "query" in tool_names
+                assert "dbutils-list-tables" in tool_names
+                assert "dbutils-run-query" in tool_names
 
                 # Test list_tables tool with PostgreSQL
-                result = await client.call_tool("list_tables", {"database": "test_pg"})
+                result = await client.call_tool("dbutils-list-tables", {"database": "test_pg"})
                 assert len(result.content) == 1
                 assert result.content[0].type == "text"
+                # 检查数据库类型前缀
+                assert "[postgres]" in result.content[0].text
                 assert "users" in result.content[0].text
 
                 # Test list_tables tool with SQLite
-                result = await client.call_tool("list_tables", {"database": "test_sqlite"})
+                result = await client.call_tool("dbutils-list-tables", {"database": "test_sqlite"})
                 assert len(result.content) == 1
                 assert result.content[0].type == "text"
+                # 检查数据库类型前缀
+                assert "[sqlite]" in result.content[0].text
                 assert "products" in result.content[0].text
 
         finally: