Esxi MCP Server

A VMware ESXi/vCenter management server based on the MCP protocol, providing a REST API interface for virtual machine management

Virtualization Monitoring #Virtualization Management #REST API #Performance Monitoring #SSE Communication .Python

rating : 2.5 points

downloads : 33

update time : 2025-04-28

What is the ESXi MCP Server?

The ESXi MCP Server is a management tool based on the MCP (Model Control Protocol) for easily managing and monitoring virtual machines on ESXi or vCenter Server. It provides powerful functions through a simple REST API interface, such as creating, cloning, deleting virtual machines, and real-time performance monitoring.

How to use the ESXi MCP Server?

You can quickly set up and start managing your virtual machines through the configuration file and API interface. You can achieve the full lifecycle management of virtual machines in just a few steps.

Application Scenarios

It is suitable for enterprise users who need to centrally manage and monitor the ESXi or vCenter Server environment, especially in scenarios where efficient scheduling and maintenance of virtualized resources are required.

Main Features

Virtual Machine ManagementSupports creating, cloning, deleting virtual machines, and turning on or off the power of virtual machines.

Performance MonitoringMonitors key indicators such as CPU, memory, storage, and network traffic in real-time.

API InterfaceProvides a RESTful API interface, supporting JSON-RPC calls for easy integration into other systems.

SSL/TLS EncryptionSupports SSL/TLS secure connections to ensure the security of data transmission.

Flexible ConfigurationSupports multiple configuration methods, including YAML, JSON, and environment variables.

Advantages and Limitations

Advantages

A simple and easy-to-use REST API interface

Support for real-time performance monitoring

Flexible configuration options

Powerful virtual machine management functions

Secure data transmission

Limitations

Requires a Python 3.7+ environment

May require more optimization for large-scale deployments

How to Use

Install Dependencies

First, install the required Python libraries, such as pyvmomi, PyYAML, and uvicorn.

Create a Configuration File

Create a configuration file named config.yaml and fill in the necessary parameters.

Start the Server

Run the server script and specify the configuration file.

Usage Examples

Create a Virtual MachineCreate a new virtual machine through the API interface.

Clone a Virtual MachineClone an existing virtual machine instance.

Frequently Asked Questions

How to verify if the server is running normally?

Does it support SSL certificates?

Related Resources

Official Documentation

Detailed user manuals and API references.

GitHub Code Repository

Open-source code and community support.

🚀 ESXi MCP Server Manager

An MCP (Model Control Protocol)-based VMware ESXi/vCenter management server that offers simple REST API interfaces for virtual machine management.

✨ Features

Support for ESXi and vCenter Server connections
Real-time communication based on SSE (Server-Sent Events)
RESTful API interfaces supporting JSON-RPC
API key authentication
Comprehensive virtual machine lifecycle management
Real-time performance monitoring
Support for SSL/TLS secure connections
Flexible configuration options (YAML/JSON/Environment variables)

✨ Core Features

Virtual Machine Management

Create VM
Clone VM
Delete VM
Power on/off operations
List all VMs

Performance Monitoring

CPU usage
Memory usage
Storage usage
Network traffic statistics

📦 Requirements

Python 3.7+
pyVmomi
PyYAML
uvicorn
mcp-core (Machine Control Protocol core library)

🚀 Quick Start

Install dependencies:

pip install pyvmomi pyyaml uvicorn mcp-core

Create a configuration file config.yaml:

vcenter_host: "your-vcenter-ip"
vcenter_user: "administrator@vsphere.local"
vcenter_password: "your-password"
datacenter: "your-datacenter"        # Optional
cluster: "your-cluster"              # Optional
datastore: "your-datastore"          # Optional
network: "VM Network"                # Optional
insecure: true                       # Ignore SSL certificate verification
api_key: "your-api-key"             # API access key
log_file: "./logs/vmware_mcp.log"   # Log file path
log_level: "INFO"                    # Log level

Run the server:

python server.py -c config.yaml

📚 Documentation

Authentication

All privileged operations require prior authentication:

POST /sse/messages
Authorization: Bearer your-api-key

Main Tool Interfaces

Create a VM

{
    "name": "vm-name",
    "cpu": 2,
    "memory": 4096,
    "datastore": "Data store name",
    "network": "Network name"
}

Clone a VM

{
    "template_name": "Source VM name",
    "new_name": "New VM name"
}

Delete a VM

{
    "name": "vm-name"
}

Power operations

{
    "name": "vm-name"
}

Resource Monitoring Interface

Get VM performance data:

GET vmstats://{vm_name}

Configuration

Property	Details	Required	Default
vcenter_host	vCenter/ESXi server address	Yes	-
vcenter_user	Login username	Yes	-
vcenter_password	Login password	Yes	-
datacenter	Datacenter name	No	Automatically select the first one
cluster	Cluster name	No	Automatically select the first one
datastore	Storage name	No	Automatically select the largest available storage
network	Network name	No	VM Network
insecure	Ignore SSL verification	No	false
api_key	API access key	No	-
log_file	Log file path	No	Console output
log_level	Log level	No	INFO

Environment Variables

All configuration items support being set via environment variables, following these naming rules:

VCENTER_HOST
VCENTER_USER
VCENTER_PASSWORD
VCENTER_DATACENTER
VCENTER_CLUSTER
VCENTER_DATASTORE
VCENTER_NETWORK
VCENTER_INSECURE
MCP_API_KEY
MCP_LOG_FILE
MCP_LOG_LEVEL

💡 Usage Tip

Security Recommendations

Production environment:
- Use valid SSL certificates
- Enable API key authentication
- Set appropriate log levels
- Limit API access scope
Test environment:
- Set insecure: true to skip SSL verification
- Use a more detailed log level (DEBUG)

📄 License

MIT License

🤝 Contribution

Issues and pull requests are welcome!

📝 Change Log

v0.1

Initial version released

📜 Intellectual Property Statement

This project adheres to the MIT license. Please refer to the LICENSE file for specific details.

⚠️ Important Note

This documentation is rewritten based on the original content and not directly generated from the source code. Please refer to the official documentation or source code for citations.