update_ip_address

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

With no annotations, the description must disclose behavioral traits. It only says 'Update an existing IP address record,' revealing no information about partial vs. full update, permissions, side effects, or failure modes. The 'existing' implies a not-found error, but this is minimal.

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: a one-line purpose followed by a concise parameter list. Every sentence contributes value, though the parameter explanations are sparse.

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?

For an update mutation tool, the description does not clarify whether it is a partial update (only provided fields are changed) or how it behaves if address_id is not found. It also ignores the output schema, which is otherwise available. The tool is simple, but the description still leaves critical ambiguity.

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?

The schema has 0% description coverage, so the description carries the weight. It lists each parameter: address_id is explained as 'ID of the IP address to update,' while hostname, description, and owner are only given 'New ...' labels. This adds basic meaning but lacks format, constraints, or update semantics.

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 an existing IP address record,' using a specific verb (update) and resource (IP address record). This clearly distinguishes it from delete_ip_address and reserve_ip_address, but it does not explicitly reference alternatives.

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 provided about when to use this tool compared to alternatives like reserve_ip_address or update_subnet. The description lacks any context, prerequisites, or exclusions.

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