opnsense_route_gateway_apply

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

No annotations provided, but description discloses potential WAN connectivity impact, destructive nature, and explicit confirmation requirement, which are key behavioral traits beyond a simple apply.

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?

Extremely concise with three sentences. Front-loads the action, then provides context and warning. No extraneous information.

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 no annotations or output schema, the description fully addresses purpose, prerequisite, side effects, and confirmation requirement, making it complete for this simple apply 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?

Schema coverage is 100% and parameter 'confirm' is fully described in the schema. The description restates that it must be true but adds no additional semantic value beyond the schema.

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 the tool applies pending gateway configuration changes, specifies the API endpoint, and distinguishes itself from sibling tools like opnsense_route_apply by focusing on gateway configuration and referencing the update tool.

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 it is required after opnsense_route_gateway_update for changes to take effect, and warns about the destructive nature requiring confirmation. Does not detail alternative tools 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.