unifi_update_traffic_matching_list

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. 'Update' implies a mutation operation, but the description doesn't specify required permissions, whether changes are reversible, potential side effects (e.g., impact on network traffic), or error handling. It lacks details on rate limits, authentication needs, or what the response might contain, leaving significant gaps for safe and effective use.

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 a single, efficient sentence: 'Update a traffic matching list'. It's front-loaded with the core action and resource, with zero wasted words. This makes it easy to parse quickly, though its brevity contributes to gaps in other dimensions like guidelines and transparency.

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 the complexity of a mutation tool with 5 parameters and no annotations or output schema, the description is incomplete. It doesn't address behavioral aspects (e.g., safety, permissions), usage context, or what to expect after invocation. For a tool that modifies network configurations, more detail is needed to ensure reliable agent operation, making this inadequate overall.

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 has 100% description coverage, with each parameter documented (e.g., siteId, trafficMatchingListId, type with enum, name, items). The description adds no additional meaning beyond the schema, such as explaining the purpose of 'items' or how 'type' affects updates. Since the schema does the heavy lifting, the baseline score of 3 is appropriate, but the description doesn't compensate or enhance understanding.

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 'Update a traffic matching list' clearly states the action (update) and resource (traffic matching list), which is adequate. However, it doesn't differentiate from sibling tools like 'unifi_update_acl_rule' or 'unifi_update_firewall_zone' beyond the resource name, nor does it specify what aspects are updated (e.g., name, items, type). This makes it vague compared to more specific descriptions.

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. It doesn't mention prerequisites (e.g., needing an existing traffic matching list from 'unifi_create_traffic_matching_list' or 'unifi_get_traffic_matching_list'), nor does it contrast with other update tools like 'unifi_update_network'. Without such context, an agent might misuse it or overlook necessary steps.

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