Skip to content

Commit 4425000

Browse files
committed
chore: update readme
1 parent 5876fc1 commit 4425000

File tree

2 files changed

+31
-34
lines changed

2 files changed

+31
-34
lines changed

README.md

Lines changed: 31 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -26,28 +26,34 @@ DBHub is a universal database gateway implementing the Model Context Protocol (M
2626
MCP Clients MCP Server Databases
2727
```
2828

29+
## Demo SSE Endpoint
30+
31+
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.
32+
33+
![mcp-inspector](https://raw.githubusercontent.com/bytebase/dbhub/main/resources/images/mcp-inspector.webp)
34+
2935
## Supported Matrix
3036

3137
### Database Resources
3238

33-
| Resource | URI Format | PostgreSQL | MySQL | SQL Server | SQLite |
34-
|------------------------|:----------:|:----------:|:-----:|:----------:|:------:|
35-
| Tables | `db://tables` || |||
36-
| Schema | `db://schema/{tableName}` || |||
39+
| Resource | URI Format | PostgreSQL | MySQL | SQL Server | SQLite |
40+
| -------- | :-----------------------: | :--------: | :---: | :--------: | :----: |
41+
| Tables | `db://tables` || |||
42+
| Schema | `db://schema/{tableName}` || |||
3743

3844
### Database Tools
3945

40-
| Tool | Command Name | PostgreSQL | MySQL | SQL Server | SQLite |
41-
|------------------------|:------------------:|:----------:|:-----:|:----------:|:------:|
42-
| Execute Query | `run_query` || |||
43-
| List Connectors | `list_connectors` || |||
46+
| Tool | Command Name | PostgreSQL | MySQL | SQL Server | SQLite |
47+
| --------------- | :---------------: | :--------: | :---: | :--------: | :----: |
48+
| Execute Query | `run_query` || |||
49+
| List Connectors | `list_connectors` || |||
4450

4551
### Prompt Capabilities
4652

47-
| Prompt | Command Name | PostgreSQL | MySQL | SQL Server | SQLite |
48-
|------------------------|:----------------:|:----------:|:-----:|:----------:|:------:|
49-
| Generate SQL | `generate_sql` || |||
50-
| Explain DB Elements | `explain_db` || |||
53+
| Prompt | Command Name | PostgreSQL | MySQL | SQL Server | SQLite |
54+
| ------------------- | :------------: | :--------: | :---: | :--------: | :----: |
55+
| Generate SQL | `generate_sql` || |||
56+
| Explain DB Elements | `explain_db` || |||
5157

5258
## Installation
5359

@@ -126,13 +132,7 @@ npx @bytebase/dbhub --transport sse --port 8080 --demo
126132
},
127133
"dbhub-demo": {
128134
"command": "npx",
129-
"args": [
130-
"-y",
131-
"@bytebase/dbhub",
132-
"--transport",
133-
"stdio",
134-
"--demo"
135-
]
135+
"args": ["-y", "@bytebase/dbhub", "--transport", "stdio", "--demo"]
136136
}
137137
}
138138
}
@@ -179,12 +179,12 @@ For real databases, a Database Source Name (DSN) is required. You can provide th
179179

180180
DBHub supports the following database connection string formats:
181181

182-
| Database | DSN Format | Example |
183-
|------------|-----------------------------------------------------------|--------------------------------------------------------|
184-
| PostgreSQL | `postgres://[user]:[password]@[host]:[port]/[database]` | `postgres://user:password@localhost:5432/dbname?sslmode=disable` |
185-
| SQLite | `sqlite:///[path/to/file]` or `sqlite::memory:` | `sqlite:///path/to/database.db` or `sqlite::memory:` |
186-
| SQL Server | `sqlserver://[user]:[password]@[host]:[port]/[database]` | `sqlserver://user:password@localhost:1433/dbname` |
187-
| MySQL | `mysql://[user]:[password]@[host]:[port]/[database]` | `mysql://user:password@localhost:3306/dbname` |
182+
| Database | DSN Format | Example |
183+
| ---------- | -------------------------------------------------------- | ---------------------------------------------------------------- |
184+
| PostgreSQL | `postgres://[user]:[password]@[host]:[port]/[database]` | `postgres://user:password@localhost:5432/dbname?sslmode=disable` |
185+
| SQLite | `sqlite:///[path/to/file]` or `sqlite::memory:` | `sqlite:///path/to/database.db` or `sqlite::memory:` |
186+
| SQL Server | `sqlserver://[user]:[password]@[host]:[port]/[database]` | `sqlserver://user:password@localhost:1433/dbname` |
187+
| MySQL | `mysql://[user]:[password]@[host]:[port]/[database]` | `mysql://user:password@localhost:3306/dbname` |
188188

189189
### Transport
190190

@@ -201,16 +201,15 @@ DBHub supports the following database connection string formats:
201201

202202
### Command line options
203203

204-
| Option | Description | Default |
205-
| :-------- | :-------------------------------------------------------------- | :---------------------------------- |
206-
| demo | Run in demo mode with sample employee database | `false` |
207-
| dsn | Database connection string | Required if not in demo mode |
208-
| transport | Transport mode: `stdio` or `sse` | `stdio` |
209-
| port | HTTP server port (only applicable when using `--transport=sse`) | `8080` |
204+
| Option | Description | Default |
205+
| :-------- | :-------------------------------------------------------------- | :--------------------------- |
206+
| demo | Run in demo mode with sample employee database | `false` |
207+
| dsn | Database connection string | Required if not in demo mode |
208+
| transport | Transport mode: `stdio` or `sse` | `stdio` |
209+
| port | HTTP server port (only applicable when using `--transport=sse`) | `8080` |
210210

211211
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.
212212

213-
214213
## Development
215214

216215
1. Install dependencies:
@@ -251,5 +250,3 @@ npx @modelcontextprotocol/inspector
251250
```
252251

253252
Connect to the DBHub server `/sse` endpoint
254-
255-
![mcp-inspector](https://raw.githubusercontent.com/bytebase/dbhub/main/resources/images/mcp-inspector.webp)
11.1 KB
Loading

0 commit comments

Comments
 (0)