unifi_list_traffic_matching_lists

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

The annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is known. The description adds useful context about the resource being named collections of ports/IPs reused in firewall/ACL rules, but it does not disclose any additional behavior beyond listing, such as pagination behavior or filter syntax, which would go beyond the schema.

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 three short sentences: the main action is stated first, followed by a compact return-shape summary and an explicit use case. There is no redundant or wasted text, while still covering purpose, output, and usage intent.

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 output schema exists and annotations cover the read-only/destructive profile, the tool is mostly complete with the description adding the domain purpose. The only minor gap is that it does not clarify when to choose this list endpoint over the singular unifi_get_traffic_matching_list, or explain the filter expression format, but these are not critical for a simple list operation.

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%, so the baseline is 3. The description does not add meaning beyond the schema: it only mentions 'at a site', which maps to the existing siteId parameter description. No additional syntax or defaults are explained in the description.

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 names a specific verb and resource ('List traffic matching lists at a site') and adds a clarifying definition of what those lists are. It does not explicitly differentiate itself from the sibling unifi_get_traffic_matching_list, though the plural 'List' and returned array shape imply the distinction.

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 includes a 'Use for:' statement that tells an agent this tool is meant for finding the matching-list ID to reference from a firewall policy, which is actionable usage guidance. It does not provide exclusions or mention alternatives such as unifi_get_traffic_matching_list for fetching a single list.

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