New here? Start with Getting started. It goes from nothing to your first question in about ten minutes.
| Guide |
What’s in it |
| Getting started |
A least-privilege API token, 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, Docker secrets, choosing toolsets, example configs |
| Using proxmox-mcp |
Example questions, built-in prompts, tasks and wait, VMIDs and nodes, how changes, extra, delete, digest and secrets work |
| 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 |
| Security |
Threat model, layers of protection, scoping the token, recommended setups, checklist |
| Compatibility |
Supported Proxmox VE versions, version-specific features, Ceph and PBS, 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 Proxmox API, testing |
| Releasing |
Versioning, cutting a release, what the release workflow does |
| Changelog |
What changed in each version |
