ipv6_firewall_address_lists

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

No annotations are provided, so the description carries the full burden. It discloses a non-obvious behavioral trait: returns an empty list (never an error) if the IPv6 package is disabled, which prevents false error handling. However, it does not mention read-only semantics, permissions, or rate limits, leaving some gaps.

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?

Front-loaded with the tool's purpose and scope in the first sentence. Three sentences total, each contributing useful information without redundancy. The reference to the README at the end is a minor addition but not wasteful.

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?

The tool is a simple read/list operation with an output schema, so return values are covered separately. The description explains purpose, sibling differentiation, and one behavioral edge case, but it completely omits any explanation of the required `device_name` parameter, which is a notable gap for correct invocation.

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 0%, and the only parameter `device_name` has no description in the schema. The description says 'on the device' which hints at the parameter's purpose but provides no format, constraints, or examples. It does not compensate for the coverage gap.

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?

States a specific verb (List) and resource (IPv6 firewall address-list entries), names the exact API path, and explicitly distinguishes itself from the IPv4 sibling `address_lists`. An agent can identify the tool's scope without opening the schema.

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 says it mirrors `address_lists` for IPv6, which implicitly tells the agent to use this tool for IPv6 instead of the IPv4 version. It also notes the empty-list behavior when the IPv6 package is disabled, which is a usage condition. No explicit when-not-to-use guidance is given.

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