mcp-dbutils

🚀 MCP 数据库工具中文指南

MCP 数据库工具为 AI 提供了便捷的数据库操作能力，支持多种安装方式，能自动识别并连接数据库，提供丰富的命令和功能。

🚀 快速开始

MCP 数据库工具可通过多种方式安装，安装完成后 AI 会自动识别并连接数据库。

📦 安装指南

方法一：MCP 安装

npx -y @mcp/core install @donghao1393/mcp-dbutils --client mcp

方法二：Docker 安装

docker pull donghao1393/mcp-dbutils:latest

方法三：Smithery 一键安装（仅限Claude）

npx -y @smithery/cli install @donghao1393/mcp-dbutils --client claude

📚 详细文档

配置说明

编辑配置文件 config.yaml：

version: '3'
databases:
  my-postgres:
    type: postgres
    host: localhost
    port: 5432
    user: youruser
    password: yourpassword
    database: yourdb

使用说明

安装完成后，AI会自动识别并连接数据库。支持以下命令：

• 列表：/list-tables
• 查询：/run-query
• 统计：/get-stats
• 约束：/list-constraints
• 解释：/explain-query
• 性能：/get-performance
• 分析：/analyze-query

示例对话

用户："能否列出我的 my-postgres 数据库中的所有表？"

AI："当然可以。以下是您数据库中的表：

• customers（客户）
• products（产品）
• orders（订单）
• inventory（库存）
• employees（员工）"

用户："customers 表的结构是什么样的？"

AI："customers 表包含以下字段：

• id（整数，主键）
• name（文本）
• email（文本）
• registration_date（日期）
• last_purchase（日期）
• total_spent（数值）"

可用工具

MCP 数据库工具提供了多种功能供 AI 使用：

• dbutils-list-tables：列出数据库中的所有表
• dbutils-run-query：执行 SQL 查询（仅 SELECT）
• dbutils-get-stats：获取表统计信息
• dbutils-list-constraints：显示表约束
• dbutils-explain-query：分析查询计划
• dbutils-get-performance：获取数据库性能指标
• dbutils-analyze-query：优化查询分析

技术文档

如需更多帮助，请参考：

• 技术指南 - 适合开发者和高级用户
• GitHub 问题 - 提交问题或功能请求
• Smithery - 简化安装与更新

📄 许可证

本项目采用 MIT 许可证，具体内容请参阅 LICENSE 文件。

⚠️ 重要提示

使用前请确保安装正确并遵守相关协议。