Skip to content

Repository files navigation

VMware Debug

Disclaimer: Community-maintained open-source project, not affiliated with, endorsed by, or sponsored by VMware, Inc. or Broadcom Inc. "VMware" and "vSphere" are trademarks of Broadcom. Source is publicly auditable under the MIT license.

The diagnostic brain of the VMware skill family. You bring the symptom (an error, a log dump, a slow VM); this skill runs a systematic investigation, correlates events from the other skills into one timeline, ranks root-cause hypotheses, and tells you what to check next. It never touches vSphere — it connects to nothing and never executes fixes; its only writes are to a local case ledger under $OPS_HOME. Remediation is routed to vmware-aiops (single op) or vmware-pilot (multi-step, gated), mirroring the vmware-harden → vmware-pilot advisor/executor split.

See skills/vmware-debug/SKILL.md for the full methodology, the event-envelope contract, and symptom routing.

MCP tools (14 — 7 read, 7 write)

The seven writes go to the local case ledger only; none reaches a VMware system.

Correlation — stateless, for a single look:

Tool What
incident_timeline [READ] Correlate pre-fetched events → timeline + spikes + ranked hypotheses + next-check ideas
list_symptom_categories [READ] List recognised symptom categories + what to check for each

Investigation ledger — for an incident you will reason about over time:

Tool What
case_open [WRITE] Define the event; returns a case id and the grade this environment can reach
case_readiness [READ] What grade this environment can reach, per symptom category, before you start
case_knowledge [READ] Which knowledge formats are accepted, what is mounted, and which entries apply to a case
case_plan [READ] What to fetch next — skill, tool and purpose per step; recomputed from the case's current state
case_list [READ] Cases, newest first
case_get [READ] One case: scope, ledger sizes, grade history
case_hypotheses [WRITE] Register a candidate explanation, or read the ledger of what supports and refutes each
case_submit_evidence [WRITE] Record one retrieved fact, with its source, query and time basis
case_record_gap [WRITE] Record what could not be retrieved, and how to close it
case_timeline [WRITE] Correlate everything the case has collected into one timeline
case_grade [WRITE] Recompute the conclusion grade from the ledger and record it
case_close [WRITE] Record the final grade, archive, and name what was left open

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-debug

License

MIT.

About

VMware diagnostic brain — read-only incident triage, log/event correlation, and root-cause routing across the VMware skill family (WIP)

Resources

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages