get_cluster_patch_compliance

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

Annotations already cover read-only/idempotent/non-destructive, and the description adds substantial context beyond them: the 503-mid-patch meaning of available=False with retry guidance, an explicit statement that it never runs remediation, and that the endpoint was verified against a live VCF 9.1 vCenter.

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

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

Front-loads the one-line purpose then uses clear labelled sections (When to use / What it returns / Gotchas) with no filler sentences. It is longer than typical but each block carries distinct, load-bearing information; minor redundancy in the return-field list keeps it just short of 5.

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

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

With no output schema, the description compensates by enumerating the return shape (available, cluster, status, hosts_total, non_compliant_hosts, scan_time, note, fields) and by flagging the required-MoID gotcha. An agent has everything needed to call and interpret this tool.

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

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

Schema coverage is 100%, so the baseline is 3, but the description adds actionable meaning: cluster must be the MoID (domain-c123), the REST API requires it, and it must come from list_all_clusters rather than the display name. That routing advice goes beyond the schema's terse 'Cluster MoID' note.

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

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

States a specific verb (get), resource (cluster patch/software compliance), and scope (one cluster, vLCM, via vSphere Automation REST). It also explicitly contrasts itself with the sibling get_host_memory_tiering (per-host hardware vs per-cluster lifecycle state), so an agent can place it without opening schemas.

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

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

The 'When to use' section names the triggering condition (checking host match to assigned image/baseline before or after a patch cycle) and contrasts with a sibling. It does not, however, distinguish itself from the closely related get_cluster_last_apply_result, which an agent might reasonably confuse with compliance.

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