vm_update

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

The description adds behavioral context beyond the schema: it includes a WRITE tag with risk=medium and notes that changes are reversible (prior values are preserved). Since no annotations are provided, this is valuable disclosure.

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 extremely concise: one header line and a bulleted list of parameters. Every sentence adds value, and the main action is front-loaded. No wasted 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?

The description adequately covers the action, parameters, and risk for a mutation tool. However, it does not describe the return value or how success is indicated, which is a minor gap given the absence of an output schema.

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 description explains each parameter's purpose and usage, including that vm_ext_id comes from vm_list, num_sockets and memory_bytes can be omitted to leave unchanged, and target is optional. This adds significant meaning over the bare schema (which has 0% description coverage).

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 'Resize a VM's CPU sockets / memory (reversible → prior values)', which is a specific verb+resource. It distinguishes from sibling VM operations like vm_create, vm_delete, vm_migrate, etc.

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 says when to use (to resize VM resources) but does not explicitly mention when not to use or provide alternatives among siblings, such as vm_clone or vm_migrate for different modifications.

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