Skip to main content

A MCP server for managing VMware Workstation Pro VMs via REST API

Project description

VMware Workstation Pro MCP Server

VMware Workstation Pro Logo

PyPI version Python versions GitHub Issues PyPI - Downloads License

Overview

A Model Context Protocol (MCP) server for managing VMware Workstation Pro virtual machines through its REST API. This server enables seamless integration with AI assistants and other tools that support the MCP standard.

Features

  • Host Network Management: Configure and manage virtual networks
  • Virtual Machine Management: Create, modify, and delete VMs
  • Network Adapter Configuration: Customize VM network settings
  • VM Power Control: Start, stop, pause, and reset virtual machines
  • Shared Folder Management: Configure shared folders between host and VMs

System Requirements

  • VMware Workstation Pro 14+ with REST API enabled
  • Python 3.10+
  • uv (recommended) or pip

Installation

# Install with uv (recommended)
uv pip install vmware-workstation-pro-mcp-server

# Or install with pip
pip install vmware-workstation-pro-mcp-server

Setup Guide

1. Configure the VMware Workstation Pro REST API

First, set up credentials for the VMware Workstation REST API:

.\vmrest.exe -C
VMware Workstation REST API
Copyright (C) 2018-2025 Broadcom.
All Rights Reserved

vmrest 1.3.1 build-24832109
Username: user
New password:
Retype new password:
Processing...
Credential updated successfully

2. Start the VMware Workstation Pro REST API

Launch the REST API service:

cd "C:\Program Files (x86)\VMware\VMware Workstation"
.\vmrest.exe
VMware Workstation REST API
Copyright (C) 2018-2025 Broadcom.
All Rights Reserved
vmrest 1.3.1 build-24832109
-
Using the VMware Workstation UI while API calls are in progress is not recommended and may yield unexpected results
-
Serving HTTP on 127.0.0.1:8697
-
Press Ctrl+C to stop.

The API service will be available at http://localhost:8697 by default.

Windows PowerShell Start REST API

VM Network Adapters Management

3. Configure the MCP Server

Add the following configuration to your MCP client setup:

{
  "mcpServers": {
    "vmware-workstation-pro": {
      "command": "uvx",
      "args": ["vmware-workstation-pro-mcp-server"],
      "env": {
        "VMREST_USER": "your-username",
        "VMREST_PASS": "your-password"
      }
    }
  }
}

Available MCP Tools

list_vms

  • Description: List all available virtual machines.
  • Parameters: None
  • Returns: Array of VM objects with their IDs and basic information

get_vm_info

  • Description: Retrieve detailed information about a specific VM.
  • Parameters:
    • vm_id (string) — The ID of the virtual machine
  • Returns: Detailed VM configuration and status information

power_vm

  • Description: Perform a power operation on a VM.
  • Parameters:
    • vm_id (string) — The ID of the virtual machine
    • action (string) — One of: "on", "off", "suspend", "pause", "unpause", "reset"
  • Returns: Operation status

get_vm_power_state

  • Description: Get the current power state of a VM.
  • Parameters:
    • vm_id (string) — The ID of the virtual machine
  • Returns: Current power state of the VM

References

Star History

Star History Chart

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vmware_workstation_pro_mcp_server-0.1.9.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file vmware_workstation_pro_mcp_server-0.1.9.tar.gz.

File metadata

File hashes

Hashes for vmware_workstation_pro_mcp_server-0.1.9.tar.gz
Algorithm Hash digest
SHA256 1268f19a1af9626958dce76d56eaae5568f6ddc8d6fdfa227cd89187bc198953
MD5 429173c44a1fe911d468ee7bae74f7f7
BLAKE2b-256 8f4714545250fbc5bebf05fd58319d92e7a256bf31c0c7744702c02e60a7f37a

See more details on using hashes here.

Provenance

The following attestation bundles were made for vmware_workstation_pro_mcp_server-0.1.9.tar.gz:

Publisher: workflow.yml on gandli/vmware-workstation-pro-mcp-server

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vmware_workstation_pro_mcp_server-0.1.9-py3-none-any.whl.

File metadata

File hashes

Hashes for vmware_workstation_pro_mcp_server-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 284ab9851356a87f9e71f7960e1f3215e2fc912fa43155c3dbe7351b7ae2a566
MD5 7626c2abefefbbb167e720850aca3f64
BLAKE2b-256 2775e935e097b5a98a1fd923fabe733d0ea43ff06323c8893b5c87b4340ad8f8

See more details on using hashes here.

Provenance

The following attestation bundles were made for vmware_workstation_pro_mcp_server-0.1.9-py3-none-any.whl:

Publisher: workflow.yml on gandli/vmware-workstation-pro-mcp-server

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page