Skip to content

Commit 1030d17

Browse files
tianzhouclaude
andcommitted
docs: give exact unpack/run commands for non-mcpb clients
Replace the vague one-liner with the verbatim unzip + node invocation and an mcpServers JSON config example, plus the Node >= 22.5 requirement and the keychain-vs-config-file trade-off. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 8559671 commit 1030d17

1 file changed

Lines changed: 38 additions & 1 deletion

File tree

docs/mcpb.mdx

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,44 @@ The [MCP Bundle](https://github.com/modelcontextprotocol/mcpb) (`.mcpb`) is a on
1111
2. Install it in your client — in Claude Desktop, double-click the file (or drag it into **Settings → Extensions**).
1212
3. Enter your database connection string when prompted, e.g. `postgres://user:password@host:5432/dbname`. It is stored in the OS keychain, not in a config file.
1313

14-
The bundle includes drivers for PostgreSQL, MySQL, MariaDB, SQL Server, and SQLite, and runs locally over stdio. Clients without native `.mcpb` support (Cursor, VS Code, ...) can still run the unpacked bundle as a plain stdio MCP server: `node server/index.js --transport stdio --config dbhub.toml` with `DBHUB_DSN` set.
14+
The bundle includes drivers for PostgreSQL, MySQL, MariaDB, SQL Server, and SQLite, and runs locally over stdio.
15+
16+
### Clients without native .mcpb support
17+
18+
Clients like Cursor and VS Code can still run the unpacked bundle as a plain stdio MCP server. An `.mcpb` is a zip archive; this path needs a local Node.js >= 22.5 (native `.mcpb` clients ship their own runtime):
19+
20+
```bash
21+
# Unpack
22+
unzip dbhub-<version>.mcpb -d ~/dbhub-mcpb
23+
24+
# Verify it runs (Ctrl-C to stop)
25+
DBHUB_DSN="postgres://user:password@host:5432/dbname" \
26+
node ~/dbhub-mcpb/server/index.js --transport stdio --config ~/dbhub-mcpb/dbhub.toml
27+
```
28+
29+
Then register it in the client's MCP config (e.g. `.cursor/mcp.json` or `.vscode/mcp.json`), using absolute paths:
30+
31+
```json
32+
{
33+
"mcpServers": {
34+
"dbhub": {
35+
"command": "node",
36+
"args": [
37+
"/home/you/dbhub-mcpb/server/index.js",
38+
"--transport",
39+
"stdio",
40+
"--config",
41+
"/home/you/dbhub-mcpb/dbhub.toml"
42+
],
43+
"env": {
44+
"DBHUB_DSN": "postgres://user:password@host:5432/dbname"
45+
}
46+
}
47+
}
48+
}
49+
```
50+
51+
Note the trade-off: here the DSN lives in a config file, not the OS keychain. For these clients the [npm install path](/installation) (`npx @bytebase/dbhub`) is usually simpler — the unpacked-bundle route only makes sense when you want the bundle's pinned, read-only configuration distributed as a single vetted artifact.
1552

1653
## Read-only by design
1754

0 commit comments

Comments
 (0)