opn_list_firewall_aliases

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

No annotations provided, so description carries full burden. Discloses return format (dict with 'rows' and 'rowCount'). Does not detail side effects (read-only), pagination, or authentication. Adequate but could elaborate on search 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?

Description is concise: 2 sentences including return value. Main action is front-loaded. No unnecessary words.

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, description still includes return structure, which is helpful. However, it lacks parameter behavior details (e.g., search matching, limit default). Adequate for a simple list tool but could be more complete.

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 0%, and description does not explain the 'search' or 'limit' parameters. Only implies search functionality via 'what IP addresses/networks they resolve to.' Fails to compensate for missing schema descriptions.

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?

Description clearly states 'List firewall alias definitions' with specific verb and resource, and lists types (IP lists, port groups, GeoIP, URLs). Differentiated from sibling tools like opn_list_firewall_categories by focusing on aliases.

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?

Explicitly states when to use: 'when you need to see which aliases are defined, their types, or what IP addresses/networks they resolve to.' Does not mention when not to use or alternatives, but context is clear for a list operation.

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