opnsense_dhcp_add_static

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

No annotations are provided, so the description carries full burden. It discloses that a DHCP service restart is required for the mapping to take effect, which is a key behavioral trait. However, it does not disclose whether overwriting existing mappings is allowed, potential conflicts, or error handling. This is adequate but not comprehensive.

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, front-loaded with purpose, then backend and restart info. Every sentence earns its place with no fluff. Well-structured and efficient.

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?

No output schema exists, so the description should ideally explain return values. It mentions behavior (restart requirement) but not what the tool returns or prerequisite conditions. It is adequate for a simple mutation tool but could be more 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 description coverage is 100%, so baseline is 3. The description adds no parameter-specific details beyond what the schema provides (e.g., MAC format, IP address, optional hostname/description). No extra value is added.

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 it adds a static DHCP mapping (MAC-to-IP reservation). It distinguishes from sibling tools like opnsense_dhcp_delete_static and opnsense_dhcp_list_static by specifying 'Add' and the resource. The mention of backend support and restart requirement adds further clarity.

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 implies usage for adding static DHCP mappings and mentions backend auto-detection, but it does not explicitly compare to alternatives or state when not to use. It provides clear context but lacks explicit exclusions or sibling differentiation.

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