Proxmox

🚀 Proxmox MCP Usage Guide

Proxmox MCP is a powerful tool that simplifies the management of Proxmox clusters. This guide provides detailed instructions on user group creation, tool usage, development, and project structure.

🚀 Quick Start

Creating User Groups

Before creating a user group, please read and understand the following points:

• The name of the user group must be unique and no more than 32 characters.
• The description of the user group should concisely explain the group's purpose.
• It is recommended to set a contact person for each user group for subsequent maintenance and management.

✨ Features

Tool Usage Guide

Executing VM Commands

Function Introduction

This tool allows you to execute commands in the virtual machine console via the QEMU Guest Agent.

Parameter Description

• node: Specify the name of the node where the virtual machine is running (required).
• vmid: Specify the ID of the virtual machine (required).
• command: Specify the specific command to be executed (required).

Usage Examples

Request Format

execute_vm_command --node <Node Name> --vmid <Virtual Machine ID> --command <Specific Command>

Response Examples

• Successful Response:

{
  "status": "SUCCESS",
  "message": "Command executed successfully"
}

• Failed Response:

{
  "status": "ERROR",
  "message": "VM not found or command execution failed"
}

Getting Cluster Status

Function Introduction

This tool is used to obtain the overall running status of the Proxmox cluster, including information such as the cluster name, status, and number of nodes.

📦 Installation

This section does not have specific installation commands in the original document, so it is skipped.

💻 Usage Examples

Basic Usage

Executing VM Commands

execute_vm_command --node node1 --vmid 100 --command "ls -l"

📚 Documentation

Development Guide

Running Tests

After activating the virtual environment, execute the following command to run tests:

pytest

Formatting Code

Use the black tool to format the project code:

black .

Type Checking

Perform static type checking via mypy:

mypy .

Code Style Checking

Use the ruff tool to check code style and specifications:

ruff .

Project Structure

proxmox-mcp/
├── src/
│   └── proxmox_mcp/
│       ├── server.py          # MCP main service implementation
│       ├── config/            # Configuration processing module
│       ├── core/              # Core function module
│       ├── formatting/        # Output formatting and theme module
│       ├── tools/             # Tool implementation module
│       │   └── console/       # Virtual machine console operation module
│       └── utils/             # Toolset (authentication, logging, etc.)
├── tests/                     # Test case directory
├── proxmox-config/
│   └── config.example.json    # Configuration file example
├── pyproject.toml            # Project metadata and dependency management
└── LICENSE                   # MIT License

🔧 Technical Details

This section does not have specific technical details in the original document, so it is skipped.

📄 License

MIT License

For further details on the detailed usage or development of Proxmox MCP, please refer to the official documentation and relevant resources.