New here? Start with Getting started. It goes from nothing to your first question in about ten minutes, with your phone to hand for the one-time SMS code.
hive-mcp is unofficial and not affiliated with Hive, British Gas or Centrica. It uses the undocumented API behind the Hive app. See Compatibility for what that means.
| Guide |
What’s in it |
| Getting started |
Running the container, the one-time SMS login, connecting Claude Code, first questions |
| Connecting MCP clients |
Claude Code, Claude Desktop, VS Code, Cursor, Codex, generic clients, stdio mode |
| Configuration |
Every environment variable, how login and remembered devices work, Docker secrets, choosing toolsets, example configs |
| Using hive-mcp |
Example conversations, built-in prompts, how changes and boosts work, caching, the raw API tool |
| Tool reference |
Every tool and argument, generated from the code |
| Guide |
What’s in it |
| Deployment |
Compose, image tags, upgrades, reverse proxies with TLS, hardening, running without Docker |
| Security |
Threat model, layers of protection, what the token file holds, recommended setups, checklist |
| Compatibility |
Supported Hive devices, discontinued products, the unofficial API and its limits |
| Troubleshooting |
Login, SMS code and remembered-device problems, error messages and how to fix them |
| Guide |
What’s in it |
| Contributing guide |
How to report issues, set up, and open pull requests |
| Development |
Architecture, the login flow, adding a tool, the mock Hive, testing |
| Releasing |
Versioning, cutting a release, what the release workflow does |
| Changelog |
What changed in each version |
