firewall_vip_list

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

No annotations are provided, so the description should disclose behavioral traits. It only states 'List all' without confirming the operation is read-only, lacks info on side effects, pagination, or any performance considerations. This is a significant gap for a tool with no annotations.

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 that conveys the tool's purpose efficiently. It is front-loaded and contains no superfluous 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 the tool's simplicity (one optional parameter, output schema present), the description is minimally adequate. However, it misses behavioral context and parameter usage guidance, making it incomplete for an agent to fully understand the tool's capabilities without relying on other 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?

The description does not mention the optional 'vdom' parameter, despite the schema providing its definition. With 100% schema coverage, the description adds no semantic value beyond the schema, failing to explain how the parameter affects the list or how to target specific VDOMs.

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 verb 'List' and the resource 'Virtual IP (DNAT) objects', making its purpose immediately obvious. It distinguishes this tool from sibling tools like firewall_vip_create and firewall_vip_get.

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 only says what the tool does but gives no guidance on when to use it versus alternatives like firewall_vip_get or firewall_vipgrp_list. There is no mention of prerequisites or exclusions, which is acceptable for a simple list operation but lacks explicit context.

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