opn_delete_alias

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

Discloses that deletion is immediate, does not use savepoint protection, and that referenced aliases cause rules to stop matching traffic. With no annotations, this provides essential behavioral context.

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?

Concise, front-loaded with the action, then important warnings and usage hints. Every sentence adds value, no redundancy.

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?

Covers the single parameter, preconditions (finding UUID, checking rules), side effects (immediate, no savepoint), and return format. With output schema present and description covering return keys, it is fully adequate for use.

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?

Though schema has 0% coverage, the description tells that the uuid is from opn_list_firewall_aliases and the action is deletion by UUID. Adds meaning beyond the bare schema by explaining the source and purpose of the parameter.

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?

Clearly states 'Delete a firewall alias by UUID', which is a specific verb+resource. It distinguishes from siblings like opn_list_firewall_aliases, opn_add_alias, and opn_update_alias by focusing on deletion.

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 instructs to use opn_list_firewall_aliases first to find the UUID, and warns to check for referencing firewall rules using opn_list_firewall_rules. Provides clear when-to-use guidance with step-by-step prerequisites.

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