set_vm_config

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

With no annotations, the description carries full burden. It indicates mutation ('Update', 'PUT') but does not disclose required permissions, whether unspecified fields are preserved or reset, rate limits, or error conditions. Behavior is minimally transparent.

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 a single sentence that front-loads the action ('Update the configuration of a QEMU VM (PUT)') and adds a key constraint. No wasted words; every part is valuable.

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 lack of output schema and annotations, and minimal parameter documentation, the description does not fully equip an agent to use the tool. The config parameter's structure is unspecified; the agent would need external knowledge or rely on sibling tools like vm_config to understand possible fields.

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%; the description adds only 'requires at least one field', which clarifies that the config object must contain at least one property. However, it does not explain the individual parameters (node, vmid, config) or their expected formats/types, leaving the agent to infer.

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 explicitly states 'Update the configuration of a QEMU VM (PUT)', which clearly identifies the action (update) and resource (VM configuration). It distinguishes from sibling tools like vm_config (GET) and set_container_config (container-focused).

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 notes 'requires at least one field', implying the config parameter must have content, but provides no explicit guidance on when to use this tool versus alternatives (e.g., when to update vs recreate). Usage context is implied but not detailed.

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