> For the complete documentation index, see [llms.txt](https://the-mothership.gitbook.io/proxmox-mcp/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://the-mothership.gitbook.io/proxmox-mcp/readme.md).

# 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](/proxmox-mcp/getting-started/...md).

## 📖 Documentation Structure

### **Getting Started**

* [**Project Roadmap**](/proxmox-mcp/getting-started/roadmap.md) - Development roadmap and feature planning
* [**Contributing Guide**](/proxmox-mcp/getting-started/contributing.md) - How to contribute to the project

### **Architecture & Development**

* [**Repository Review**](/proxmox-mcp/analysis-and-reports/repository-review.md) - Comprehensive code analysis and structure
* [**Claude Code Automation**](/proxmox-mcp/automation-and-tools/claude-code-automation.md) - Automated development workflow setup
* [**Testing Workflow**](/proxmox-mcp/development-guide/testing-workflow.md) - Comprehensive testing guide and best practices

### **Security**

* [**Security & Encryption**](/proxmox-mcp/security/security-encryption.md) - 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**](https://the-mothership.gitbook.io/proxmox-mcp/) - You're reading this live on GitBook!
* [**Main Repository**](/proxmox-mcp/getting-started/...md) - Project overview and setup
* [**GitHub Issues**](https://github.com/basher83/ProxmoxMCP/issues) - Bug reports and feature requests
* [**Pull Requests**](https://github.com/basher83/ProxmoxMCP/pulls) - Code contributions

***

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://the-mothership.gitbook.io/proxmox-mcp/readme.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.