Skip to content

bytebase/dbhub

Repository files navigation

Note

Brought to you by Bytebase, open-source database DevSecOps platform.

DBHub Logo

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

DBHub is a Universal Database MCP Server implementing the Model Context Protocol (MCP) server interface. This gateway allows MCP-compatible clients to connect to and explore different databases:

  • Universal Gateway: Single interface for PostgreSQL, MySQL, MariaDB, SQL Server, and SQLite
  • Secure Access: Read-only mode, SSH tunneling, and SSL/TLS encryption support
  • Multi-Database: Connect to multiple databases simultaneously with TOML configuration
  • Production-Ready: Row limiting, lock timeout control, and connection pooling
  • MCP Native: Full implementation of Model Context Protocol with resources, tools, and prompts

Supported Databases

PostgreSQL, MySQL, SQL Server, MariaDB, and SQLite.

MCP Components

DBHub implements MCP Resources, Tools, and Prompts for database operations:

  • Resources: Database schema exploration (schemas, tables, indexes, procedures)
  • Tools: SQL execution with transaction support
  • Prompts: AI-assisted SQL generation and database explanation

Installation

See the full Installation Guide for detailed instructions.

Quick Start

Docker:

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

NPM:

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

Demo Mode:

npx @bytebase/dbhub --transport http --port 8080 --demo

See Server Options for all available parameters.

Multi-Database Setup

Connect to multiple databases simultaneously using TOML configuration files. Perfect for managing production, staging, and development databases from a single DBHub instance.

See Multi-Database Configuration for complete setup instructions.

Development

  1. Install dependencies:

    pnpm install
  2. Run in development mode:

    pnpm dev
  3. Build for production:

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

Testing

See TESTING.md.

Debug

See Debug.

Contributors

Star History

Star History Chart

Releases

No releases published

Packages

No packages published

Contributors 15

Languages