DBHub

<p align="center"> <a href="https://dbhub.ai/" target="_blank"> <picture> <img src="https://raw.githubusercontent.com/bytebase/dbhub/main/resources/images/logo-full.webp" width="50%"> </picture> </a> </p>

DBHub 是一个实现了模型上下文协议 (MCP) 服务器接口的通用数据库网关。此网关允许 MCP 兼容的客户端连接和探索不同的数据库。

 +------------------+    +--------------+    +------------------+
 |                  |    |              |    |                  |
 |                  |    |              |    |                  |
 |  Claude Desktop  +--->+              +--->+    PostgreSQL    |
 |                  |    |              |    |                  |
 |      Cursor      +--->+    DBHub     +--->+    SQL Server    |
 |                  |    |              |    |                  |
 |     Other MCP    +--->+              +--->+     SQLite       |
 |      Clients     |    |              |    |                  |
 |                  |    |              +--->+     MySQL        |
 |                  |    |              |    |                  |
 |                  |    |              +--->+  Other Databases |
 |                  |    |              |    |                  |
 +------------------+    +--------------+    +------------------+
      MCP Clients           MCP Server             Databases

Demo SSE Endpoint

https://demo.dbhub.ai/sse 连接到一个 示例员工数据库。您可以将 Cursor 或 MCP Inspector 指向它以查看它的实际效果。

支持的矩阵

数据库资源

资源名称	URI 格式	PostgreSQL	MySQL	SQL Server	SQLite
schemas	db://schemas	✅	✅	✅	✅
tables_in_schema	db://schemas/{schemaName}/tables	✅	✅	✅	✅
table_structure_in_schema	db://schemas/{schemaName}/tables/{tableName}	✅	✅	✅	✅
indexes_in_table	db://schemas/{schemaName}/tables/{tableName}/indexes	✅	✅	✅	✅
procedures_in_schema	db://schemas/{schemaName}/procedures	✅	✅	✅	❌
procedure_details_in_schema	db://schemas/{schemaName}/procedures/{procedureName}	✅	✅	✅	❌

数据库工具

工具	命令名称	PostgreSQL	MySQL	SQL Server	SQLite
Execute Query	run_query	✅	✅	✅	✅
List Connectors	list_connectors	✅	✅	✅	✅

Prompt 能力

Prompt	命令名称	PostgreSQL	MySQL	SQL Server	SQLite
Generate SQL	generate_sql	✅	✅	✅	✅
Explain DB Elements	explain_db	✅	✅	✅	✅

安装

Docker

# PostgreSQL 示例
docker run --rm --init \
   --name dbhub \
   --publish 8080:8080 \
   bytebase/dbhub \
   --transport sse \
   --port 8080 \
   --dsn "postgres://user:password@localhost:5432/dbname?sslmode=disable"

# 带有示例员工数据库的演示模式
docker run --rm --init \
   --name dbhub \
   --publish 8080:8080 \
   bytebase/dbhub \
   --transport sse \
   --port 8080 \
   --demo

NPM

# PostgreSQL 示例
npx @bytebase/dbhub --transport sse --port 8080 --dsn "postgres://user:password@localhost:5432/dbname"

# 带有示例员工数据库的演示模式
npx @bytebase/dbhub --transport sse --port 8080 --demo

注意：演示模式包含一个捆绑的 SQLite 示例“employee”数据库，其中包含 employees、departments、salaries 等表。

Claude Desktop

• Claude Desktop 仅支持 stdio 传输 https://github.com/orgs/modelcontextprotocol/discussions/16

// claude_desktop_config.json
{
  "mcpServers": {
    "dbhub-postgres-docker": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "bytebase/dbhub",
        "--transport",
        "stdio",
        "--dsn",
        // 如果连接到本地数据库，请使用 host.docker.internal 作为主机
        "postgres://user:password@host.docker.internal:5432/dbname?sslmode=disable"
      ]
    },
    "dbhub-postgres-npx": {
      "command": "npx",
      "args": [
        "-y",
        "@bytebase/dbhub",
        "--transport",
        "stdio",
        "--dsn",
        "postgres://user:password@localhost:5432/dbname?sslmode=disable"
      ]
    },
    "dbhub-demo": {
      "command": "npx",
      "args": ["-y", "@bytebase/dbhub", "--transport", "stdio", "--demo"]
    }
  }
}

Cursor

• Cursor 支持 stdio 和 sse。
• 按照 Cursor MCP 指南 并确保使用 Agent 模式。

用法

配置您的数据库连接

您可以使用 DBHub 在演示模式下使用示例员工数据库进行测试：

npx @bytebase/dbhub  --demo

对于真实的数据库，需要数据库源名称 (DSN)。您可以通过以下几种方式提供此信息：

• 命令行参数（最高优先级）：

  npx @bytebase/dbhub  --dsn "postgres://user:password@localhost:5432/dbname?sslmode=disable"
  

• 环境变量（第二优先级）：

  export DSN="postgres://user:password@localhost:5432/dbname?sslmode=disable"
  npx @bytebase/dbhub
  

• 环境变量文件（第三优先级）：

  • 对于开发：使用您的 DSN 创建 .env.local
  • 对于生产：使用您的 DSN 创建 .env

  DSN=postgres://user:password@localhost:5432/dbname?sslmode=disable
  

[!WARNING] 在 Docker 中运行时，使用 host.docker.internal 而不是 localhost 连接到在您的主机上运行的数据库。例如：mysql://user:password@host.docker.internal:3306/dbname

DBHub 支持以下数据库连接字符串格式：

数据库	DSN 格式	示例
PostgreSQL	postgres://[user]:[password]@[host]:[port]/[database]	postgres://user:password@localhost:5432/dbname?sslmode=disable
SQLite	sqlite:///[path/to/file] 或 sqlite::memory:	sqlite:///path/to/database.db 或 sqlite::memory:
SQL Server	sqlserver://[user]:[password]@[host]:[port]/[database]	sqlserver://user:password@localhost:1433/dbname
MySQL	mysql://[user]:[password]@[host]:[port]/[database]	mysql://user:password@localhost:3306/dbname

传输

• stdio（默认）- 用于与 Claude Desktop 等工具直接集成：

  npx @bytebase/dbhub --transport stdio --dsn "postgres://user:password@localhost:5432/dbname?sslmode=disable"
  

• sse - 用于浏览器和网络客户端：

  npx @bytebase/dbhub --transport sse --port 5678 --dsn "postgres://user:password@localhost:5432/dbname?sslmode=disable"
  

命令行选项

选项	描述	默认值
demo	在演示模式下使用示例员工数据库运行	false
dsn	数据库连接字符串	如果不在演示模式下，则为必需
transport	传输模式：stdio 或 sse	stdio
port	HTTP 服务器端口（仅在使用 --transport=sse 时适用）	8080

演示模式使用加载了 示例员工数据库 的内存 SQLite 数据库，该数据库包括 employees、departments、titles、salaries、department employees 和 department managers 的表。示例数据库包括用于表创建、数据加载和测试的 SQL 脚本。

开发

1. 安装依赖项：

   pnpm install
   

2. 在开发模式下运行：

   pnpm dev
   

3. 构建用于生产：

   pnpm build
   pnpm start --transport stdio --dsn "postgres://user:password@localhost:5432/dbname?sslmode=disable"
   

使用 MCP Inspector 调试

stdio

# PostgreSQL 示例
TRANSPORT=stdio DSN="postgres://user:password@localhost:5432/dbname?sslmode=disable" npx @modelcontextprotocol/inspector node /path/to/dbhub/dist/index.js

SSE

# 使用 SSE 传输启动 DBHub
pnpm dev --transport=sse --port=8080

# 在另一个终端中启动 MCP Inspector
npx @modelcontextprotocol/inspector

连接到 DBHub 服务器 /sse 端点

Star History