list_traffic_rules

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 says 'List' implying a read operation, but does not explicitly disclose side effects (none expected), permission needs, or response behavior. No pagination or error context is given, which is a gap for a list 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?

Two concise sentences: the first states the function, the second covers parameter formats. No filler. It is efficiently front-loaded and easy to parse, though it could potentially include a usage note without becoming bloated.

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?

With an output schema present, the return shape is covered. However, given the large sibling list and no annotations, the description misses usage context and does not hint at related resources (e.g., create/update/delete traffic rules). It is minimally sufficient but lacks the context needed to confidently choose this tool in complex workflows.

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 input schema only contains generic string types with 0% coverage. The description compensates by explaining accepted formats for 'host' (name, ID, or composite MAC:numericId) and 'site' (name or ID), giving the agent critical value that the schema lacks.

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 states a specific verb ('List') and resource ('traffic matching rules'), and clarifies the rule categories (QoS, application, IP group matching). This clearly distinguishes it from sibling tools like list_traffic_matching_lists, which are about matching lists rather than 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?

The description provides parameter value formats but gives no guidance on when to use this tool versus alternatives. It does not mention exclusions or prerequisites, leaving usage context entirely to inference.

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