Get firewall list

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

Annotations already declare readOnlyHint=true and destructiveHint=false. The description adds no new behavioral details such as pagination behavior, rate limits, or response shape; it only echoes the safe read-only nature of the operation.

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 brief and front-loaded, with the core purpose in the first sentence. The second sentence is somewhat redundant with the first, but it does reinforce the usage intent without adding meaningful bloat.

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?

For a simple list operation with one optional page parameter and read-only annotations, the description is adequate. An agent can infer the call's purpose and safety. It could clarify pagination behavior, but the schema already covers the parameter.

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?

Schema description coverage is 100%, and the only parameter, 'page', is already documented as 'Page number'. The description adds no extra meaning about pagination semantics, defaults, or how pagination interacts with 'all available firewalls'.

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 specific verbs and resource nouns: 'Retrieve all available firewalls' and 'view existing firewall configurations.' The word 'all' and the plural 'list' orientation clearly distinguish this from sibling creation/update/delete/detail endpoints like VPS_getFirewallDetailsV1.

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 explicitly states when to use it: 'Use this endpoint to view existing firewall configurations.' It does not name alternatives or edge cases like retrieving a single firewall's details, so it stops short of a full when-to-use/when-not-to-use guide.

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