unifi_create_firewall_rule

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

With no annotations, the description carries the full burden of behavioral disclosure. It only describes parameters and their values, but omits side effects (e.g., rule activation, interaction with other rules), authorization needs, or reversibility. The agent cannot assess destructive potential or runtime behavior.

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 sentence that front-loads the purpose, but then packs many parameter explanations with semicolons. It is concise but could be better structured (e.g., bullet points) for readability. Every phrase adds value, but the density may reduce clarity.

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 13 parameters, no output schema, and no annotations, the description is incomplete. It does not explain return values, the meaning of firewallgroup_ids, site_id context, or logging. For a create operation, typical usage context (e.g., 'this rule takes effect immediately') is missing. More details are needed for a complete understanding.

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 description adds meaning to 6 of 13 parameters beyond the schema (ruleset, action, protocol, src/dst addresses and ports) by listing allowed values and providing formats (e.g., port range '80' or '8080:8090'). However, it ignores parameters like site_id, enabled, and firewall group IDs, leaving gaps. Given 0% schema coverage, the description partially compensates.

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 'Create a firewall rule' which is a specific verb+resource. It lists the main parameters and allowed values, distinguishing it from sibling tools like update_firewall_rule by naming convention. However, it could be more explicit about the resource being created.

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 (e.g., update_firewall_rule). It doesn't mention prerequisites like site existence or that the rule is newly created and not for modifying existing ones. The agent must infer usage from the name alone.

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