Get VM Details

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

Annotations already mark this as read-only and idempotent. The description adds useful context beyond annotations by specifying that it reads the .vmx configuration file and checks running status, plus it lists the returned fields. This clarifies the underlying mechanism without contradicting any 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?

The description is well-structured and front-loaded with a clear purpose, followed by behavior, args, and returns. However, the Args section is incomplete since it omits vm_password, which slightly undermines the otherwise clean structure.

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?

For a simple read-only tool, the description adequately covers what it does, what it reads, and what it returns. It lacks details about error behavior (e.g., missing file or encrypted VM without password), but the annotations and schema cover the overall safety and required parameters.

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 schema fully describes both parameters. The description's Args section only mentions vmx_path and omits vm_password, but the schema covers the password requirement. No additional parameter semantics are provided beyond the structured 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 clearly states this tool gets detailed information about a specific VMware Fusion VM by reading the .vmx file and checking running status. It distinguishes from sibling list tools by focusing on a single VM's config and status, though it doesn't explicitly name alternatives.

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 read-only nature and 'detailed information' imply when to use it, and the sibling list shows alternatives are listing/starting/snapshot tools. However, there is no explicit guidance on when not to use it or how it compares to related tools like fusion_get_ip or fusion_check_tools.

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