Open VM migration tunnel

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

The description adds context by stating it 'opens a tunnel' (side effect) and returns data, supplementing the openWorldHint annotation. However, it does not disclose behavioral traits like permissions needed, tunnel lifetime, or rate limits.

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 two sentences with clear front-loading of the action. Every word is useful and no redundant information.

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 three parameters, no output schema, and an openWorldHint annotation, the description is too brief. It omits details about the return format, optional port behavior, and its role as a prerequisite for migration.

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?

With 0% schema description coverage, the description should compensate but does not. Parameters (node, port, vmid) are only listed in the schema with basic types; no additional meaning, defaults, or constraints beyond the schema are provided.

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 action ('Open a tunnel'), the resource ('for VM migration'), and the expected output ('Returns port/ticket info'). This distinguishes it from sibling tools like 'migrate_vm' which likely perform the actual migration.

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 implies usage before VM migration but provides no explicit guidance on when to use this tool versus alternatives (e.g., migrate_vm). No exclusions or context for when not to use it.

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