opnsense_firmware_reboot

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

With no annotations, the description fully carries the burden of disclosing behavior. It clearly states the tool causes a network outage on the firewall and services, and that it requires confirmation via the confirm parameter. The destructive nature is highlighted.

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 two concise sentences. The first states the action, the second provides critical consequences and the destructive flag. No unnecessary words, front-loaded with key 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?

The description covers the essential context: action, network impact, and confirmation requirement. It lacks mention of return value or behavior after reboot command, but for a simple reboot tool, this is sufficiently 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 coverage is 100%, so baseline is 3. The description adds that the tool is destructive and requires confirmation, reinforcing the parameter's purpose but not adding significant new meaning beyond the schema's enum constraint.

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 action 'Reboot the OPNsense system' with a specific verb and resource. It distinguishes from sibling tools, as no other tool performs a system reboot.

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 warns that the tool is destructive and requires explicit confirmation, implying cautious use. However, it does not explicitly state when not to use it or provide alternatives, but given no sibling reboot tool, this is adequate.

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