unifi_list_firewall_groups

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

There are no annotations, so the description carries full burden for behavioral disclosure. 'List' implies a safe read operation, but the description does not disclose whether results are scoped to the current site, whether pagination is applied, or what the output structure is. It adds no details beyond the basic action.

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, focused sentence with no wasted words. It directly communicates the tool's purpose and is appropriately sized for a parameterless list operation.

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 tool's simplicity (no parameters, no output schema), the description covers the core purpose. However, it does not mention what information is returned for each group (e.g., name, type, members), which could be relevant for an agent deciding whether this tool meets its needs. This is a minor gap for a 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?

The tool has zero parameters, and the input schema is empty. The baseline for 0 params is 4, as there is nothing to describe. The description does not need to explain parameter semantics since none exist.

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 clearly states the tool lists configured firewall IP and port groups, using a specific verb ('List') and resource ('firewall IP & port groups'). It is unambiguous and distinct from sibling tools like unifi_list_firewall_rules, which list rules, not groups.

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 implies usage: when you need to see configured firewall groups, you call this tool. However, it provides no explicit guidance on when to use it over alternatives, nor does it mention any exclusions or prerequisites. Since it's a simple list operation, implied usage is acceptable but not clearly stated.

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