README

Welcome to the comprehensive documentation for ProxmoxMCP - a Python-based Model Context Protocol (MCP) server for managing Proxmox hypervisors.

🚀 Quick Start

For installation and basic usage, see the main README.

📖 Documentation Structure

Getting Started

• Project Roadmap - Development roadmap and feature planning

• Contributing Guide - How to contribute to the project

Architecture & Development

• Repository Review - Comprehensive code analysis and structure

• Claude Code Automation - Automated development workflow setup

• Testing Workflow - Comprehensive testing guide and best practices

Security

• Security & Encryption - Token encryption and security practices

🛠️ Development

This project uses modern Python development practices:

• Python 3.10+ for MCP compatibility

• FastMCP for the server framework

• Pydantic for data validation

• Docker for containerized deployment

📋 Configuration

The server requires proper configuration for Proxmox API access. See the configuration examples in the proxmox-config/ directory.

🤖 Automation

This project includes Claude Code automation for issue resolution. When you assign an issue with the claude-code label, it automatically:

1. Creates a branch

2. Implements the solution

3. Runs tests and quality checks

4. Creates a pull request

🔗 Links

• 📚 Live Documentation - You're reading this live on GitBook!

• Main Repository - Project overview and setup

• GitHub Issues - Bug reports and feature requests

• Pull Requests - Code contributions

---

This documentation is built with GitBook and automatically synced with the repository. 📖 Live URL: https://the-mothership.gitbook.io/proxmox-mcp/