put_fw_dmz

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

No annotations are provided, so the description carries full burden. It lists error codes (noent, internal_error, exist) which is helpful, but does not disclose what the update does (e.g., whether it sets replacement or merge behavior), auth requirements, or side effects.

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 very short (two lines) but includes misleading information. It could be more concise if accurate, but the content is incomplete and incorrectly names the resource.

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?

With 6 parameters (none required) and an output schema, the description fails to explain what the output contains, how the update interacts with existing configuration, or any relationship to get_fw_dmz or put_lan_config. The error codes are a positive addition, but overall context is lacking.

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%, with good descriptions for each parameter. However, the description's claim of updating 'LanConfig' is inconsistent with the schema fields (Freebox Server address, names, type) which seem more aligned with general network configuration rather than DMZ. The description adds confusion rather than clarity.

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 states 'Update the current LanConfig', but the tool name put_fw_dmz implies updating the firewall DMZ configuration. This mismatch between description and tool name creates confusion about the tool's actual purpose. There is a sibling get_fw_dmz, suggesting put_fw_dmz should update DMZ, not LanConfig.

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?

No guidance on when to use this tool versus alternatives like put_lan_config or other put_ tools. The description does not specify prerequisites, required fields, or context for use.

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