vsz_list_vlan_pools

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions the HTTP endpoint (POST /vlanpoolings) but does not disclose read-only status, authentication requirements, pagination, or any side effects. This is a minimal disclosure.

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 appropriately short and front-loaded with the main purpose 'List VLAN pooling profiles.' The additional lines about the endpoint and argument are focused and add necessary detail without redundancy.

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?

This is a simple one-parameter list tool with an output schema available. The description covers the core function and the host parameter. However, given the lack of annotations, it would benefit from a brief note on expected behavior (e.g., safe read-only operation), but overall it is sufficiently complete for its simplicity.

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 provides only a bare 'host' string property with no description. The description compensates by explaining that host is the 'vSZ controller IP or hostname,' adding meaningful 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 clearly states the tool lists 'VLAN pooling profiles,' using a specific verb and resource. This distinguishes it from sibling tools like vsz_get_vlan_pool, which targets a single pool. It is not a tautology and conveys the exact scope.

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 such as vsz_get_vlan_pool or vsz_list_dhcp_pools. It only states the tool's function, leaving the agent to infer usage from the tool name alone.

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