Skip to content

Commit 2c07f19

Browse files
committed
docs: readme
1 parent 6591cc0 commit 2c07f19

File tree

2 files changed

+29
-23
lines changed

2 files changed

+29
-23
lines changed

README.md

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -11,31 +11,33 @@
1111
</a>
1212
</p>
1313

14-
![Star History Chart](https://api.star-history.com/svg?repos=bytebase/dbhub&type=Date)
15-
16-
</p>
17-
18-
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.
19-
2014
```bash
21-
+------------------+ +--------------+ +------------------+
22-
| | | | | |
23-
| | | | | |
24-
| Claude Desktop +--->+ +--->+ PostgreSQL |
25-
| | | | | |
26-
| Claude Code +--->+ +--->+ SQL Server |
27-
| | | | | |
28-
| Cursor +--->+ DBHub +--->+ SQLite |
29-
| | | | | |
30-
| VS Code +--->+ +--->+ MySQL |
31-
| | | | | |
32-
| Other Clients +--->+ +--->+ MariaDB |
33-
| | | | | |
34-
| | | | | |
35-
+------------------+ +--------------+ +------------------+
36-
MCP Clients MCP Server Databases
15+
+------------------+ +--------------+ +------------------+
16+
| | | | | |
17+
| | | | | |
18+
| Claude Desktop +--->+ +--->+ PostgreSQL |
19+
| | | | | |
20+
| Claude Code +--->+ +--->+ SQL Server |
21+
| | | | | |
22+
| Cursor +--->+ DBHub +--->+ SQLite |
23+
| | | | | |
24+
| VS Code +--->+ +--->+ MySQL |
25+
| | | | | |
26+
| Other Clients +--->+ +--->+ MariaDB |
27+
| | | | | |
28+
| | | | | |
29+
+------------------+ +--------------+ +------------------+
30+
MCP Clients MCP Server Databases
3731
```
3832

33+
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:
34+
35+
- **Universal Gateway**: Single interface for PostgreSQL, MySQL, MariaDB, SQL Server, and SQLite
36+
- **Secure Access**: Read-only mode, SSH tunneling, and SSL/TLS encryption support
37+
- **Multi-Database**: Connect to multiple databases simultaneously with TOML configuration
38+
- **Production-Ready**: Row limiting, lock timeout control, and connection pooling
39+
- **MCP Native**: Full implementation of Model Context Protocol with resources, tools, and prompts
40+
3941
## Supported Databases
4042

4143
PostgreSQL, MySQL, SQL Server, MariaDB, and SQLite.
@@ -119,3 +121,7 @@ See [Debug](https://dbhub.ai/config/debug).
119121
<a href="https://github.com/bytebase/dbhub/graphs/contributors">
120122
<img src="https://contrib.rocks/image?repo=bytebase/dbhub" />
121123
</a>
124+
125+
## Star History
126+
127+
![Star History Chart](https://api.star-history.com/svg?repos=bytebase/dbhub&type=Date)

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"build:frontend": "cd frontend && pnpm run build",
2323
"start": "node dist/index.js",
2424
"dev": "concurrently --kill-others \"pnpm run dev:backend\" \"pnpm run dev:frontend\"",
25-
"dev:backend": "NODE_ENV=development tsx src/index.ts --demo --transport=http",
25+
"dev:backend": "NODE_ENV=development tsx src/index.ts --transport=http",
2626
"dev:frontend": "cd frontend && pnpm run dev",
2727
"crossdev": "cross-env NODE_ENV=development tsx src/index.ts",
2828
"generate:api-types": "openapi-typescript src/api/openapi.yaml -o src/api/openapi.d.ts",

0 commit comments

Comments
 (0)