Migrate VM between nodes

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

Adds behavioral nuance about live vs offline migration beyond annotations (which show non-destructive mutation). However, lacks details on prerequisites (e.g., shared storage) or VM state after migration.

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?

Two concise sentences, directly stating purpose and key behavior. No unnecessary words, front-loaded.

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 migration tool with 6 parameters and no output schema, the description covers the essential purpose and a key behavioral switch (online). Missing prerequisites and implications of other parameters make it minimally 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?

Schema has 83% parameter description coverage; description only calls out 'online' explicitly. Does not add meaning beyond what the schema provides for other parameters like force or target_node.

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?

Description clearly states 'Migrate a VM to a different node (live or offline)' – a specific verb and resource. Among sibling tools like migrate_container and migrate_ha_resource, this uniquely targets VMs.

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?

Gives basic context for online migration ('With online=true the VM keeps running') but does not contrast with sibling migration tools (e.g., migrate_container, node_migrate_all) or provide when-not-to-use guidance.

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