Hyperbolic Gateway Developer Knowledge
This is the developer-facing OKF bundle for Hyperbolic Gateway: the
Electron app, the local HTTP bridge, the hb-browser MCP server, the
hb-rest MCP server, and the wrapper/recipe formats.
It is written for people building agents, MCP clients, integrations, or saved REST tools on top of the app. It is not the end-user manual.
Start here
- Install and run - local app, build from source, and the bridge.
- Connect an MCP client -
hb-browser,hb-rest, bundled runtime, and environment variables. - First browser session - health check, navigate, observe, act, and wait.
- Examples - a complete browser task and a complete REST wrapper.
Understand the system
- Runtime architecture - Electron, Chromium, the HTTP bridge, and the two MCP servers.
- Security model - local trust boundaries, bridge tokens, credentials, SSRF policy, and human takeover.
API reference
- Browser MCP API - the
hb-browserserver, tool groups, resources, and call shape. - REST MCP API - the
hb-restserver, ten meta-tools, generated tools, and discovery. - Remote MCP gateway (experimental) - the Streamable HTTP gateway and its auth/session model.
- Development logs MCP - local-only development log access.
- Local bridge HTTP API - supported local control-plane routes and authentication.
- Wrapper format - the saved request, input schema, auth reference, and validation rules.
- Recipe format - JSON-to-Markdown projection, templates, limits, and pagination.
- Error catalogue - browser, wrapper, and bridge error codes.
Related documentation
- Documentation hub - user-facing documentation, architecture notes, and operations guides.
- Hyperbolic Rest man page - the full operational guide for wrappers and credentials.
- Build and packaging - installers, CI, signing, and release policy.
- Codebase map - subsystem map and implementation findings.
Using this bundle
Every concept is Markdown with YAML frontmatter. The bundle can be read
directly from the repository, served as static files, or crawled by an
agent. The Pages build publishes both the readable HTML pages and the raw
OKF Markdown at /developer/.
The older kuang_docs/okf.json bundle is a custom agent-orcha manifest used
for the browser playbooks and MCP resources. It is not part of this standard
OKF v0.2 bundle.