ESXi MCP Server

1# ESXi MCP Server
2 
3A VMware ESXi/vCenter management server based on MCP (Model Control Protocol), providing simple REST API interfaces for virtual machine management.
4 
5## Features
6 
7- Support for ESXi and vCenter Server connections
8- Real-time communication based on SSE (Server-Sent Events)
9- RESTful API interface with JSON-RPC support
10- API key authentication
11- Complete virtual machine lifecycle management
12- Real-time performance monitoring
13- SSL/TLS secure connection support
14- Flexible configuration options (YAML/JSON/Environment Variables)
15 
16## Core Functions
17 
18- Virtual Machine Management
19  - Create VM
20  - Clone VM
21  - Delete VM
22  - Power On/Off operations
23  - List all VMs
24- Performance Monitoring
25  - CPU usage
26  - Memory usage
27  - Storage usage
28  - Network traffic statistics
29 
30## Requirements
31 
32- Python 3.7+
33- pyVmomi
34- PyYAML
35- uvicorn
36- mcp-core (Machine Control Protocol core library)
37 
38## Quick Start
39 
401. Install dependencies:
41 
42```bash
43pip install pyvmomi pyyaml uvicorn mcp-core
44```
45 
462. Create configuration file `config.yaml`:
47 
48```yaml
49vcenter_host: "your-vcenter-ip"
50vcenter_user: "administrator@vsphere.local"
51vcenter_password: "your-password"
52datacenter: "your-datacenter"        # Optional
53cluster: "your-cluster"              # Optional
54datastore: "your-datastore"          # Optional
55network: "VM Network"                # Optional
56insecure: true                       # Skip SSL certificate verification
57api_key: "your-api-key"             # API access key
58log_file: "./logs/vmware_mcp.log"   # Log file path
59log_level: "INFO"                    # Log level
60```
61 
623. Run the server:
63 
64```bash
65python server.py -c config.yaml
66```
67 
68## API Interface
69 
70### Authentication
71 
72All privileged operations require authentication first:
73 
74```http
75POST /sse/messages
76Authorization: Bearer your-api-key
77```
78 
79### Main Tool Interfaces
80 
811. Create VM
82```json
83{
84    "name": "vm-name",
85    "cpu": 2,
86    "memory": 4096,
87    "datastore": "datastore-name",
88    "network": "network-name"
89}
90```
91 
922. Clone VM
93```json
94{
95    "template_name": "source-vm",
96    "new_name": "new-vm-name"
97}
98```
99 
1003. Delete VM
101```json
102{
103    "name": "vm-name"
104}
105```
106 
1074. Power Operations
108```json
109{
110    "name": "vm-name"
111}
112```
113 
114### Resource Monitoring Interface
115 
116Get VM performance data:
117```http
118GET vmstats://{vm_name}
119```
120 
121## Configuration
122 
123| Parameter | Description | Required | Default |
124|-----------|-------------|----------|---------|
125| vcenter_host | vCenter/ESXi server address | Yes | - |
126| vcenter_user | Login username | Yes | - |
127| vcenter_password | Login password | Yes | - |
128| datacenter | Datacenter name | No | Auto-select first |
129| cluster | Cluster name | No | Auto-select first |
130| datastore | Storage name | No | Auto-select largest available |
131| network | Network name | No | VM Network |
132| insecure | Skip SSL verification | No | false |
133| api_key | API access key | No | - |
134| log_file | Log file path | No | Console output |
135| log_level | Log level | No | INFO |
136 
137## Environment Variables
138 
139All configuration items support environment variable settings, following these naming rules:
140- VCENTER_HOST
141- VCENTER_USER
142- VCENTER_PASSWORD
143- VCENTER_DATACENTER
144- VCENTER_CLUSTER
145- VCENTER_DATASTORE
146- VCENTER_NETWORK
147- VCENTER_INSECURE
148- MCP_API_KEY
149- MCP_LOG_FILE
150- MCP_LOG_LEVEL
151 
152## Security Recommendations
153 
1541. Production Environment:
155   - Use valid SSL certificates
156   - Enable API key authentication
157   - Set appropriate log levels
158   - Restrict API access scope
159 
1602. Testing Environment:
161   - Set insecure: true to skip SSL verification
162   - Use more detailed log level (DEBUG)
163 
164## License
165 
166MIT License
167 
168## Contributing
169 
170Issues and Pull Requests are welcome!
171 
172## Changelog
173 
174### v0.0.1
175- Initial release
176- Basic VM management functionality
177- SSE communication support
178- API key authentication
179- Performance monitoring
180 
181## Author
182 
183Bright8192
184 
185## Acknowledgments
186 
187- VMware pyvmomi team
188- MCP Protocol development team
189