Proxmox MCP Server

🚀 Proxmox MCP Project Documentation

Proxmox MCP is a powerful tool designed to manage Proxmox clusters efficiently. It provides comprehensive functions for VM management, storage management, network management, and more.

🚀 Quick Start

Configuration File

Copy config.example.json to config.json and modify the configuration as needed.

Start the MCP Service

Start MCP in a virtual environment:

python -m proxmox_mcp.server

✨ Features

MCP offers the following core features:

• VM Management: Create, delete, and manage virtual machines.
• Storage Management: Configure and monitor storage pools.
• Network Management: Manage network interfaces and firewall rules.
• Cluster Status: View status information for the entire Proxmox cluster.

📦 Installation

Installation Methods

1. Install via PyPI: Use pip to install:

   pip install proxmox-mcp
   

2. Install from Source Code: Clone the repository and install:

   git clone https://github.com/yourusername/proxmox-mcp.git
   cd proxmox-mcp
   python setup.py install
   

💻 Usage Examples

Get Help

Use mcp --help to view all available commands and their options.

🔧 Technical Details

Run Tests

Run tests in a virtual environment:

pytest tests/

Format Code

Format the project code:

black .

Type Checking

Perform static type checking:

mypy .

Code Style Check

Check the code style:

ruff .

Project Structure

proxmox-mcp/
├── src/
│   └── proxmox_mcp/
│       ├── server.py          # Main MCP service implementation
│       ├── config/            # Configuration handling module
│       ├── core/              # Core functionality module
│       ├── formatting/        # Output formatting and theme module
│       ├── tools/             # Tool implementation module
│       │   └── console/       # VM console operation sub - module
│       └── utils/             # Auxiliary tool module (authentication, logging)
├── tests/                     # Test suite directory
├── proxmox-config/
│   └── config.example.json    # Configuration file example
├── pyproject.toml            # Project metadata and dependency management
└── LICENSE                   # MIT license file

📄 License

MIT License

License Terms

Copyright © [Year] [Author's Name]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.