New here? Start with Getting started. It goes from nothing to your first question in about ten minutes.
octopus-mcp is an independent, unofficial project. It isn’t made, endorsed or supported by Octopus Energy.
| Guide |
What’s in it |
| Getting started |
Getting your API key, running the container, 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 authentication works, Docker secrets, choosing toolsets, example configs |
| Using octopus-mcp |
Example conversations, built-in prompts, units and prices, cost estimates, EV charging, Saving Sessions, the raw API tools |
| 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, the API key, recommended setups, checklist |
| Compatibility |
The Octopus APIs, meters and tariffs, and known gaps |
| Troubleshooting |
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, adding a tool, the mock Octopus API, testing |
| Releasing |
Versioning, cutting a release, what the release workflow does |
| Changelog |
What changed in each version |
