get_vm_details

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

No annotations are provided, so the description carries full responsibility. It states the return format (YAML string containing details or error) and specifies the vm_id format, implying a read-only, idempotent operation. It could be improved by explicitly noting no side effects.

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 concise with two short sections. The first sentence immediately states the purpose, followed by parameter and return details. No unnecessary words.

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 one parameter and an output schema (though not shown), the description covers parameter usage and return type. It lacks error condition details, but for a simple get tool, this is adequate.

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?

The schema has 0% description coverage, but the description adds significant meaning by explaining the vm_id composite format ('provider:tenant:region:instance_id'). This helps an agent correctly construct the parameter 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 clearly states the function: 'Get detailed information about a specific virtual machine.' The verb 'get' and noun 'details' precisely indicate a read operation, distinguishing it from sibling tools like list_vms (list all) or start_vm (mutate).

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 description specifies that the tool retrieves details for one VM. While it doesn't explicitly state when not to use it, the sibling context (list_providers, list_vms, etc.) provides implicit guidance. A brief mention of alternatives would improve clarity.

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