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

• - Development roadmap and feature planning

• - How to contribute to the project

Architecture & Development

• - Comprehensive code analysis and structure

• - Automated development workflow setup

• - Comprehensive testing guide and best practices

Security

• - 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

📋 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

• - You're reading this live on GitBook!

• - Project overview and setup

• - Bug reports and feature requests

This documentation is built with GitBook and automatically synced with the repository. 📖 Live URL: