sdcloud_list_firewall_policy_hierarchy

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

Without annotations, the description should disclose behavioral traits like read-only nature, required permissions, or return format. It only mentions listing hierarchy but omits pagination behavior (though schema includes from/size/count) and whether results are nested. The description adds little beyond the tool name.

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 single sentence is front-loaded with verb and resource, making it easy to scan. However, it could be structured with brief bullet points or a second sentence to highlight key features like pagination support.

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 7 parameters and no output schema, the description is incomplete. It should explain pagination (from, size, count), sorting, filtering, and what 'hierarchy' means (e.g., nested vs flat). The current description leaves the agent guessing about return structure and usage details.

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 86%, so most parameters are already documented in the schema. The description adds minimal value—merely restating scope from the enum. It does not clarify how filters or sortby work or the meaning of policy_uuid in context of hierarchy.

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 precisely states the tool lists a firewall policy's rule hierarchy with a given scope (global or zone). This clearly differentiates it from sibling tools like sdcloud_list_firewall_policies (lists policies) and sdcloud_list_firewall_policy_rules (flat list of rules).

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?

No guidance is provided on when to use this tool versus alternatives such as sdcloud_list_firewall_policy_rules or sdcloud_get_firewall_policy. There is no mention of prerequisites, when not to use, or which scenarios benefit from the hierarchy view.

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