opnsense_if_configure

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

The description discloses that the tool works on already-assigned slots, supports various IP modes, and includes a no_filter_reload parameter to control behavior. It lacks details on error cases or side effects, but given no annotations, this is reasonable.

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?

Two sentences: first covers purpose and supported modes, second lists prerequisites. No redundant information, front-loaded with the key action.

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 tool has 9 parameters and no output schema. The description explains core purpose, supported modes, prerequisites, and one behavioral parameter (no_filter_reload). Missing details on return values or error handling, but sufficient for typical 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?

Schema coverage is 100%, so baseline is 3. The description adds value by explaining supported IP modes (static, dhcp, etc.) and how parameters like subnet are conditionally required, which goes beyond the 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?

The description explicitly states 'Configure IPv4/IPv6 on an already-assigned optN slot via SSH' and lists supported modes. This clearly distinguishes it from sibling tools like opnsense_if_assign (for assignment) and opnsense_if_get (read-only).

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 mentions prerequisites (OPNSENSE_SSH_ENABLED=true and the required script), which guides when the tool can be used. However, it does not explicitly state when not to use it vs alternatives, though the context is implied.

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