create_virtual_ip

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

Annotations already indicate readOnlyHint=false and destructiveHint=false. The description adds no additional behavioral context, such as whether the creation is applied immediately (though the apply_immediately parameter exists) or whether a separate apply_virtual_ip_changes call is needed. No contradiction.

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, concise sentence with no filler or redundant information, making it easy to parse quickly.

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 tool's complexity (11 parameters, multiple modes like CARP/ipalias, and related apply/update/delete siblings), the description is under-specified. It doesn't mention that the virtual IP must be assigned to an existing interface, or that CARP mode requires additional parameters, leaving the agent to infer from the schema. The output schema may help, but the description itself is not sufficiently complete.

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 schema's property descriptions provide comprehensive coverage (100%), documenting all 11 parameters with details like 'VHID group number (required for CARP, 1-255)' and 'Interface to assign the VIP to (wan, lan, opt1, etc.)'. The description adds no parameter semantics beyond the schema.

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 uses a specific verb ('Create') and resource ('a virtual IP address'), clearly distinguishing from sibling tools like update_virtual_ip, delete_virtual_ip, and search_virtual_ips. It states exactly what the tool does.

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 provides no guidance on when to use this tool versus alternatives, nor does it mention prerequisites such as existing interfaces or CARP requirements. There is no context about when to prefer this over update_virtual_ip or delete_virtual_ip.

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