opnsense_route_gateway_apply

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

No annotations exist, so description carries full burden. It discloses the API call, potential brief WAN disruption, and destructive nature requiring confirmation. Additional details like service restart behavior could enhance but are not critical.

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?

Three concise sentences, front-loaded with action and purpose, no redundant text. Every sentence adds value.

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?

Tool is simple (one parameter, no output schema). Description explains necessity, effects, and usage context fully. No gaps for an agent to leverage.

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 has 100% coverage with one parameter 'confirm' (boolean, enum true). Description mentions 'requires explicit confirmation' which adds mild context beyond schema, but baseline is appropriate as schema already documents the parameter well.

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 applies pending gateway configuration changes, specifies the API endpoint, and distinguishes it from sibling tools like opnsense_route_gateway_update and opnsense_route_apply by noting it is required after an update.

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 (after opnsense_route_gateway_update) and warns about potential WAN impact and required confirmation. Does not explicitly list conditions to avoid, but context is clear.

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