Skip to content

Commit c66101c

Browse files
committed
chore(docs): explain hyperdb-bootstrap in hyperdb-mcp build-from-source
Previously the build-from-source section just said "set HYPERD_PATH or put hyperd on PATH" without telling the reader how to get hyperd in the first place. Now it walks through cargo-install hyperdb-bootstrap + download, with a fallback note for users who already have hyperd from another Tableau Hyper API distribution.
1 parent d1cc61f commit c66101c

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

‎hyperdb-mcp/README.md‎

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,24 @@ cd hyper-api-rust
8282
cargo build --release -p hyperdb-mcp
8383
```
8484

85-
The binary is at `target/release/hyperdb-mcp`. When building from source, the `hyperd` executable must be available separately — set the `HYPERD_PATH` environment variable or ensure it's on your `PATH`.
85+
The binary is at `target/release/hyperdb-mcp`.
86+
87+
When building from source the `hyperd` executable is **not** bundled, so
88+
you'll need to provide one. The easiest path is the companion
89+
[`hyperdb-bootstrap`](../hyperdb-bootstrap/) CLI, which downloads a
90+
matching pinned `hyperd` for your platform:
91+
92+
```bash
93+
cargo install hyperdb-bootstrap
94+
hyperdb-bootstrap download # installs into ./.hyperd/current/
95+
export HYPERD_PATH="$PWD/.hyperd/current" # or pass via your MCP config
96+
```
97+
98+
`hyperdb-bootstrap` also has a library API if you'd rather wire the
99+
download into your own build script — see its
100+
[README](../hyperdb-bootstrap/README.md). If you already have `hyperd`
101+
elsewhere (Tableau Hyper API for C++/Python/Java ships one), point
102+
`HYPERD_PATH` at it or add it to your `PATH`.
86103

87104
### MCP Client Configuration
88105

0 commit comments

Comments
 (0)