opnsense_if_assign

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

With no annotations, the description must fully disclose behavioral traits. It mentions SSH and script dependency but does not detail whether the operation is destructive, reversible, or idempotent, nor does it describe return values or side effects beyond assignment.

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 extremely concise at two sentences, with the primary action and method front-loaded, followed by prerequisites and rationale. No superfluous 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 the lack of output schema and the mutative nature of the tool, the description fails to mention post-assignment behavior (e.g., whether the change is applied immediately, need for reload, success/failure indicators). This is a significant gap for a network configuration change.

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?

All three parameters are fully specified in the schema with clear descriptions. The tool description adds no additional semantic context beyond what the schema provides, and schema coverage is 100%, so baseline of 3 is appropriate.

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 (assign), resource (existing VLAN or NIC device to optN slot), and method (via SSH). It distinguishes from siblings by noting it fills the gap where the REST API has no endpoints for interface assignments.

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 specifies prerequisites (environment variable and script installation) and explains the context (gap in REST API). However, it does not explicitly state when alternatives should be used, like sibling tools for interface configuration or VLAN management.

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