Skip to main content
Glama
vmware-skills

io.github.zw008/vmware-debug

get_case_readiness

Read-onlyIdempotent

Check what conclusion strength a VMware environment can reach before investigating: evidence class availability and per-category ceilings, plus how to supply missing sources.

Instructions

[READ] What strength of conclusion can this environment reach?

WHEN: before starting an investigation, or when a case will not go higher and you want to know whether that is fixable. Answering this first is worth far more than discovering it halfway through.

RETURNS: {classes, categories, unrecognised_skills, note}. A name that matched no skill in the catalogue comes back in unrecognised_skills rather than being absorbed into "not installed" — otherwise a typo reads as advice to install something you already have. Per evidence class: whether it is available, through which tools, and if not, how_to_supply. Per symptom category (storage, network, compute, ha_drs, configuration, accelerator, kubernetes, hardware, host_lifecycle, power_lifecycle, auth, platform, licensing, data_collection): a ceiling and the independent_sources behind it. There is deliberately no single score — "readiness 78%" cannot be acted on, "storage reaches Probable, hardware reaches Candidate" can.

GOTCHAS: two classes served by the SAME skill count as one source, so two available classes do not always mean Probable. The hardware class is unavailable no matter what is installed — nothing in this family reaches below ESXi — and the knowledge class becomes available only when entries are mounted under $OPS_HOME/knowledge/.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
available_skillsNoThe skills actually installed and configured, in either of the family's spellings — "monitor" and "vmware-monitor" name the same thing. Omit to assume all of them, which reports the ceiling imposed by the family itself rather than by this install. A name matching no catalogued skill comes back in `unrecognised_skills` rather than being read as "not installed".

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv2.3.0

TDQS

A4.1/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations cover the safety profile (readOnly, idempotent, not destructive, closed-world), and the description adds genuinely non-obvious behavior: two classes served by the same skill count as one source, the hardware class is never reachable in this family, and the knowledge class only activates with entries under $OPS_HOME/knowledge/. These are real traps an agent could not derive from structured fields.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with a [READ] tag and WHEN/RETURNS/GOTCHAS sections, which makes scanning easy. There is mild redundancy: unrecognised_skills behavior is explained in both the RETURNS block and the parameter schema, and the category enumeration is lengthy, but the structure earns its length for a no-output-schema tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description must carry the return contract, and it does: field names, the rationale for unstructured ceilings over a single score, and an explicit statement that no aggregate score exists. Combined with the gotchas, an agent has everything needed to call and interpret this correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100% and the single optional parameter's aliasing rule ('monitor' vs 'vmware-monitor') and omit-behavior are already documented in the schema. The description restates the unrecognised_skills consequence rather than adding new semantics. Baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific, if rhetorically framed, purpose: determining what strength of conclusion the environment can reach. The RETURNS block makes the resource concrete (evidence classes, symptom categories, ceilings). It stops short of naming siblings like grade_case or plan_case, so an agent must infer the boundary between 'readiness' and 'grading' from context.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicit WHEN clause gives two triggering conditions: before starting an investigation, and when a case stalls and you want to know if the ceiling is fixable. It even argues the sequencing ('worth far more than discovering it halfway through'). No explicit when-not or named alternative tool, which keeps it from a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.