Regenerate VM identity

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

The description adds context by specifying what gets regenerated (MAC addresses, UUID), but does not disclose potential side effects like network disruption or authorization requirements. Annotations already indicate non-read-only and non-destructive, so the description adds moderate value.

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 sentences, front-loaded with the core action and optional details. No unnecessary words. Efficient and clear.

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?

Covers purpose and usage context but omits prerequisites, side effects, or return behavior. For a simple tool with no output schema, it is adequate but could include more safety-related context.

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 only 33% schema coverage, the description does not compensate for the lack of parameter descriptions for node and vmid. It indirectly explains the force parameter through the tool description, but no detailed semantics 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 'Regenerate the VM's MAC addresses and (optionally) SMBIOS UUID', specifying the verb, resource, and exact attributes. It distinguishes from sibling tools like update_vm_config and clone_vm by focusing on regeneration.

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?

Mentions 'Useful after cloning', which implies a usage scenario but does not explicitly state when to use this tool vs alternatives or exclude cases. No direct comparison to similar tools.

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