Skip to main content

VMware Pilot

Author: Wei Zhou, VMware by Broadcom — wei-wz.zhou@broadcom.com This is a community-driven project by a VMware engineer, not an official VMware product. For official VMware developer tools see developer.broadcom.com.

English | 中文

Multi-step workflow orchestration for VMware MCP skills — state machine, approval gates, audit trail.

Companion skills handle everything else:

Skill Scope Install
vmware-aiops VM lifecycle, deployment, guest ops, cluster uv tool install vmware-aiops
vmware-monitor Read-only: inventory, health, alarms, events uv tool install vmware-monitor
vmware-storage Datastores, iSCSI, vSAN management uv tool install vmware-storage
vmware-vks Tanzu Namespaces, TKC cluster lifecycle uv tool install vmware-vks
vmware-nsx NSX networking: segments, gateways, NAT uv tool install vmware-nsx-mgmt
vmware-nsx-security DFW firewall rules, security groups uv tool install vmware-nsx-security
vmware-aria Aria Ops: metrics, alerts, capacity uv tool install vmware-aria
vmware-avi AVI load balancing, pool management, AKO K8s ops uv tool install vmware-avi

Install

uv tool install vmware-pilot
vmware-pilot mcp          # start the MCP server (stdio)

Offline / Air-Gapped Install (from source)

This project uses the modern PEP 517 build system (hatchling), so there is no setup.py by design — that is expected, not a missing file. If you cloned the source and hit ERROR: File "setup.py" or "setup.cfg" not found ... editable mode currently requires a setuptools-based build, your pip is older than 21.3 and cannot do an editable (-e) install with a non-setuptools backend. Editable mode is a developer convenience, not needed to run the tool — do one of:

# From the source tree — a normal (non-editable) install builds a wheel:
pip install .              # NOT  pip install -e .

# ...or upgrade pip first, and editable works too:
pip install --upgrade pip && pip install -e .

For a truly air-gapped host, build the wheels on a connected machine and copy them over — the target then needs no network:

# On a connected machine, collect this package + its dependencies as wheels:
pip wheel . -w dist        # → dist/*.whl   (or: uv build, for just this package)

# Copy dist/ to the air-gapped host, then install offline:
pip install --no-index --find-links dist vmware-pilot

MCP Tools (13 — 4 read, 9 write)

Tool Description
get_skill_catalog List all available skills and tools for workflow design
list_workflows List built-in and custom templates
review_workflow Sanity-check a planned workflow before execution
design_workflow Natural language goal → draft workflow
update_draft Edit draft workflow steps
confirm_draft Finalize draft → ready to execute
plan_workflow Generate execution plan from template, returns workflow_id
create_workflow Create custom workflow from step list (refused if a destructive step has no approval gate before it)
run_workflow Execute workflow, pauses at approval gates
get_workflow_status Query state + diff report + audit log
approve Human approval, continue execution
rollback Explicit, best-effort undo of steps pilot recorded as succeeded — never automatic
cancel_workflow Cancel a workflow — move it to the terminal CANCELLED state

Built-in Templates (15)

n is the number of VMs (or drift items); ranges depend on which optional parameters are set. clone_and_test has 7 steps when change_spec is a guest command (an extra gate before it runs in staging). investigate_alert's approvals are synthesis checkpoints; its steps are all reads. See skills/vmware-pilot/references/templates.md for parameters and steps.

Template Steps Approval Skills Used
clone_and_test 6-7 Yes aiops, monitor
incident_response 4 Yes monitor, aiops
investigate_alert 4 (8 with deep_dive) Yes monitor, aria
plan_and_approve 3 Yes aiops
compliance_scan 1-3 No monitor, aria
network_segment_setup 3-6 Yes nsx, nsx-security
vks_cluster_deploy 4 Yes vks
rolling_restart 2+3n Yes aiops, monitor
capacity_expansion 5 Yes aria, aiops, monitor
disaster_recovery 5 Yes aiops, monitor, nsx
patch_deployment 1+3n Yes aiops, monitor
storage_expansion 6 Yes storage
baseline_capture 1-5 No monitor, nsx, storage
baseline_audit 1-5 No monitor, nsx, storage, aria
baseline_remediate 3+n Yes varies

MCP Configuration

{
  "mcpServers": {
    "vmware-pilot": {
      "command": "vmware-pilot",
      "args": ["mcp"]
    }
  }
}

Fallback: {"command": "uvx", "args": ["--from", "vmware-pilot", "vmware-pilot-mcp"]} still works, but uvx re-resolves against PyPI on every start and fails behind a TLS-inspecting corporate proxy (invalid peer certificate: UnknownIssuer). The installed entry point above touches the network zero times; set UV_NATIVE_TLS=true if you must use uvx.

License

MIT

Download files

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

Source Distribution

vmware_pilot-1.10.1.tar.gz (276.3 kB view details)

Uploaded Source

Built Distribution

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

vmware_pilot-1.10.1-py3-none-any.whl (66.8 kB view details)

Uploaded Python 3

File details

Details for the file vmware_pilot-1.10.1.tar.gz.

File metadata

  • Download URL: vmware_pilot-1.10.1.tar.gz
  • Upload date:
  • Size: 276.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.12

File hashes

Hashes for vmware_pilot-1.10.1.tar.gz
Algorithm Hash digest
SHA256 ffa37c8d22cdf0b1a7f1a1e347fb20be31b9598d4f1a5d73f49991bd50fb4cea
MD5 7e4438f4568fea8209eb4cf33ad4a250
BLAKE2b-256 8e1cfc4c4a46b92a743301bcccf01a38ce252a8a2fdc2ee0976925effa101bc1

See more details on using hashes here.

File details

Details for the file vmware_pilot-1.10.1-py3-none-any.whl.

File metadata

  • Download URL: vmware_pilot-1.10.1-py3-none-any.whl
  • Upload date:
  • Size: 66.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.13.12

File hashes

Hashes for vmware_pilot-1.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 74654cbd9349c61d8ff5f0087233fee00cc8f8c68922a1ee136f205c7f17556b
MD5 f00b850dd639ceebc9c9dab32f30f02d
BLAKE2b-256 c5602d00ea0e21db9a0eed58f9636a89af37a0ac4844897fd2116db21618af4a

See more details on using hashes here.

Release history Release notifications | RSS feed

1.11.1

2 files

1.11.0

2 files

This release

1.10.1 This release

2 files

1.10.0

2 files

1.9.0

2 files

1.8.12

2 files

1.8.11

2 files

1.8.10

2 files

1.8.9

2 files

1.8.8

2 files

1.8.7

2 files

1.8.5

2 files

1.8.4

2 files

1.8.3

2 files

1.8.2

2 files

1.8.1

2 files

1.8.0

2 files

1.6.2

2 files

1.6.1

2 files

1.5.38

2 files

1.5.37

2 files

1.5.36

2 files

1.5.35

2 files

1.5.22

2 files

1.5.21

2 files

1.5.19

2 files

1.5.17

2 files

1.5.16

2 files

1.5.14

2 files

1.5.13

2 files

1.5.12

2 files

1.5.11

2 files

1.5.10

2 files

1.5.8

2 files

1.5.7

2 files

1.5.6

2 files

1.5.5

2 files

1.5.4

2 files

1.5.3

2 files

1.5.0

2 files

1.4.9

2 files

1.4.5

2 files

1.4.4

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page