storage_rescan

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

The description adds details beyond annotations: 'Non-destructive: only triggers device and VMFS discovery (deletes nothing), but it is I/O-visible on the host and may take a minute or two with many paths. Audit-logged to ~/.vmware/audit.db.' It contradicts none of the annotations.

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?

Well-structured with a summary paragraph followed by a clear Args section. Every sentence adds value without redundancy. Front-loaded with purpose and usage.

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?

Given the parameter count, annotations, and presence of an output schema (not shown), the description provides complete context: when to use, behavior, parameter details, error handling, and side effects.

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 0%, but the description compensates with detailed Args: 'host_name: FQDN or IP, errors if not found', 'dry_run: preview without executing', 'target: optional default target'. This adds crucial meaning beyond the raw schema.

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?

The description starts with '[WRITE]' and clearly states the verb-resource combination: 'Rescan all HBAs and VMFS volumes on an ESXi host to discover newly presented LUNs and datastores.' It distinguishes itself from siblings like storage_iscsi_add_target etc., making the purpose unambiguous.

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?

Explicit guidance: 'Use after a storage array presents new LUNs or after out-of-band SAN changes. Not needed after storage_iscsi_add_target / storage_iscsi_remove_target — those rescan automatically.' This clearly tells when and when not to use.

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