ips_add

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

With no annotations, the description bears the full burden of behavioral disclosure. It does state that 'confirm: Required', which is behaviorally relevant, but this conflicts with the input schema where confirm is optional with a default of false. The description does not disclose admin permissions, side effects, or irreversibility of the operation.

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 compact and wastes no words. The one-line purpose is front-loaded and the Args section is readable. The only structural issue is that 'confirm: Required' is presented as a parameter description rather than a clear usage requirement, and it conflicts with the schema.

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?

This is a state-changing administrative tool with no annotations and no usage guidance. The description lacks context around when to use this versus ips_assign, whether the IP must be unused, confirmation requirements, or any consequences of the operation. An output schema exists, but it does not compensate for missing tool-selection and behavioral context.

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 0%, so the description must compensate. It adds some meaning: netmask is clarified as 'IPv4 or prefix hint', and confirm is described as required. However, ip is merely restated as 'Address to add', and confirm's 'required' status contradicts the schema, making the parameter guidance partial and somewhat inconsistent.

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 a specific action and resource: 'Add an IP to the admin IP manager.' This clearly identifies what the tool does. However, it does not distinguish itself from the sibling ips_assign, which could also involve adding or associating IPs, so it falls short of full differentiation.

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 is given about when to use this tool instead of related tools such as ips_assign, ips_remove, or csf_allow_ip. The description only outlines the operation and parameters, leaving the agent to infer the appropriate context.

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