https://github.com/bytebase/dbhub
Universal database MCP server connecting to MySQL, PostgreSQL, SQL Server, SQLite, and etc.
https://github.com/bytebase/dbhub
ai anthropic claude claude-ai cursor cursorai database mcp mcp-server mysql postgres sqlite sqlserver
Last synced: 10 months ago
JSON representation
Universal database MCP server connecting to MySQL, PostgreSQL, SQL Server, SQLite, and etc.
- Host: GitHub
- URL: https://github.com/bytebase/dbhub
- Owner: bytebase
- License: mit
- Created: 2025-03-09T16:36:38.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-03-18T15:57:18.000Z (10 months ago)
- Last Synced: 2025-03-18T16:46:26.162Z (10 months ago)
- Topics: ai, anthropic, claude, claude-ai, cursor, cursorai, database, mcp, mcp-server, mysql, postgres, sqlite, sqlserver
- Language: TypeScript
- Homepage:
- Size: 729 KB
- Stars: 32
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mcp - bytebase/dbhub - efficient multi-database MCP ☆`1,859` (Databases / Multi-Database Tools)
- awesome-mcp-servers - Database - A universal MCP server supporting multiple database types, such as PostgreSQL, Redshift, CockroachDB, MySQL, RDS MySQL, Microsoft SQL Server, BigQuery, Oracle DB, and SQLite. ([Read more](/details/database.md)) `mcp` `database` `postgresql` `mysql` `cloud` (Database & Messaging MCP Servers)
- awesome-mcp-servers - bytebase/dbhub
- awesome-mcp-servers - DBHub - Universal database MCP server connecting to MySQL, PostgreSQL, SQL Server, SQLite, and etc. (Table of Contents / Databases)
- awesome-mcp-servers - **bytebase/dbhub** - 📇 Universal database MCP server supporting mainstream databases.\ `database` `http` `ai` `git` `github` (📦 Other)
- awesome-mcp-servers - bytebase/dbhub
- Awesome-MCP-Servers-directory - bytebase/dbhub - Universal database MCP server supporting mainstream databases (Databases)
- toolsdk-mcp-registry - ❌ @bytebase/dbhub - only SQL queries with built-in safety checks (node) (Databases / How to Submit)
- metorial-index - Universal Database Gateway - Connects to various databases and executes read-only SQL queries with safety checks, providing a unified interface for database management. (APIs and HTTP Requests)
- awesome-mcp-list - bytebase/dbhub
- awesome - bytebase/dbhub - Zero-dependency, token-efficient database MCP server for Postgres, MySQL, SQL Server, MariaDB, SQLite. (TypeScript)
- awesome-ai-agents - bytebase/dbhub - DBHub is a minimal, token-efficient MCP server providing a unified interface for secure and efficient management and exploration of multiple databases including PostgreSQL, MySQL, MariaDB, SQL Server, and SQLite. (Agent Integration & Deployment Tools / MCP Server Framework)
- awesome-devops-mcp - bytebase/dbhub - Universal database MCP server supporting MySQL, PostgreSQL, SQLite, DuckDB and more (🗄️ Databases)
- awesome-mcp - bytebase/dbhub - DBHub is a universal database gateway implementing the Model Context Protocol (MCP) server interface, enabling MCP clients to connect to and explore multiple database systems including MySQL, PostgreSQL, Oracle, SQL Server, MariaDB, and SQLite. (MCP Servers / Databases)
README
DBHub is a universal database gateway implementing the Model Context Protocol (MCP) server interface. This gateway allows MCP-compatible clients to connect to and explore different databases.
```bash
+------------------+ +--------------+ +------------------+
| | | | | |
| | | | | |
| 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 connects a [sample employee database](https://github.com/bytebase/employee-sample-database). You can point Cursor or MCP Inspector to it to see it in action.
## Supported Matrix
### Database Resources
| Resource | URI Format | PostgreSQL | MySQL | SQL Server | SQLite |
| -------- | :-----------------------: | :--------: | :---: | :--------: | :----: |
| Tables | `db://tables` | ✅ | ✅ | ✅ | ✅ |
| Schema | `db://schema/{tableName}` | ✅ | ✅ | ✅ | ✅ |
### Database Tools
| Tool | Command Name | PostgreSQL | MySQL | SQL Server | SQLite |
| --------------- | :---------------: | :--------: | :---: | :--------: | :----: |
| Execute Query | `run_query` | ✅ | ✅ | ✅ | ✅ |
| List Connectors | `list_connectors` | ✅ | ✅ | ✅ | ✅ |
### Prompt Capabilities
| Prompt | Command Name | PostgreSQL | MySQL | SQL Server | SQLite |
| ------------------- | :------------: | :--------: | :---: | :--------: | :----: |
| Generate SQL | `generate_sql` | ✅ | ✅ | ✅ | ✅ |
| Explain DB Elements | `explain_db` | ✅ | ✅ | ✅ | ✅ |
## Installation
### Docker
```bash
# PostgreSQL example
docker run --rm --init \
--name dbhub \
--publish 8080:8080 \
bytebase/dbhub \
--transport sse \
--port 8080 \
--dsn "postgres://user:password@localhost:5432/dbname?sslmode=disable"
```
```bash
# Demo mode with sample employee database
docker run --rm --init \
--name dbhub \
--publish 8080:8080 \
bytebase/dbhub \
--transport sse \
--port 8080 \
--demo
```
### NPM
```bash
# PostgreSQL example
npx @bytebase/dbhub --transport sse --port 8080 --dsn "postgres://user:password@localhost:5432/dbname"
```
```bash
# Demo mode with sample employee database
npx @bytebase/dbhub --transport sse --port 8080 --demo
```
> Note: The demo mode includes a bundled SQLite sample "employee" database with tables for employees, departments, salaries, and more.
### Claude Desktop
- Claude Desktop only supports `stdio` transport https://github.com/orgs/modelcontextprotocol/discussions/16
```json
// claude_desktop_config.json
{
"mcpServers": {
"dbhub-postgres-docker": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"bytebase/dbhub",
"--transport",
"stdio",
"--dsn",
// Use host.docker.internal as the host if connecting to the local db
"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 supports both `stdio` and `sse`.
- Follow [Cursor MCP guide](https://docs.cursor.com/context/model-context-protocol) and make sure to use [Agent](https://docs.cursor.com/chat/agent) mode.
## Usage
### Configure your database connection
You can use DBHub in demo mode with a sample employee database for testing:
```bash
pnpm dev --demo
```
For real databases, a Database Source Name (DSN) is required. You can provide this in several ways:
- **Command line argument** (highest priority):
```bash
pnpm dev --dsn "postgres://user:password@localhost:5432/dbname?sslmode=disable"
```
- **Environment variable** (second priority):
```bash
export DSN="postgres://user:password@localhost:5432/dbname?sslmode=disable"
pnpm dev
```
- **Environment file** (third priority):
- For development: Create `.env.local` with your DSN
- For production: Create `.env` with your DSN
```
DSN=postgres://user:password@localhost:5432/dbname?sslmode=disable
```
DBHub supports the following database connection string formats:
| Database | DSN Format | Example |
| ---------- | -------------------------------------------------------- | ---------------------------------------------------------------- |
| PostgreSQL | `postgres://[user]:[password]@[host]:[port]/[database]` | `postgres://user:password@localhost:5432/dbname?sslmode=disable` |
| SQLite | `sqlite:///[path/to/file]` or `sqlite::memory:` | `sqlite:///path/to/database.db` or `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` |
### Transport
- **stdio** (default) - for direct integration with tools like Claude Desktop:
```bash
npx @bytebase/dbhub --transport stdio --dsn "postgres://user:password@localhost:5432/dbname?sslmode=disable"
```
- **sse** - for browser and network clients:
```bash
npx @bytebase/dbhub --transport sse --port 5678 --dsn "postgres://user:password@localhost:5432/dbname?sslmode=disable"
```
### Command line options
| Option | Description | Default |
| :-------- | :-------------------------------------------------------------- | :--------------------------- |
| demo | Run in demo mode with sample employee database | `false` |
| dsn | Database connection string | Required if not in demo mode |
| transport | Transport mode: `stdio` or `sse` | `stdio` |
| port | HTTP server port (only applicable when using `--transport=sse`) | `8080` |
The demo mode uses an in-memory SQLite database loaded with the [sample employee database](https://github.com/bytebase/dbhub/tree/main/resources/employee-sqlite) that includes tables for employees, departments, titles, and salaries.
## Development
1. Install dependencies:
```bash
pnpm install
```
1. Run in development mode:
```bash
pnpm dev
```
1. Build for production:
```bash
pnpm build
pnpm start --transport stdio --dsn "postgres://user:password@localhost:5432/dbname?sslmode=disable"
```
### Debug with [MCP Inspector](https://github.com/modelcontextprotocol/inspector)
#### stdio
```bash
# PostgreSQL example
TRANSPORT=stdio DSN="postgres://user:password@localhost:5432/dbname?sslmode=disable" npx @modelcontextprotocol/inspector node /path/to/dbhub/dist/index.js
```
#### SSE
```bash
# Start DBHub with SSE transport
pnpm dev --transport=sse --port=8080
# Start the MCP Inspector in another terminal
npx @modelcontextprotocol/inspector
```
Connect to the DBHub server `/sse` endpoint