instance_list_ipv4

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

With no annotations, the description carries the burden. 'List' and 'Returns: List of IPv4 addresses' signal a read operation and basic output shape, and the accepted instance_id forms are helpful. However, it does not disclose whether public/private addresses are included, ordering, pagination, or failure behavior.

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 well-structured with a one-line summary, Args, and Returns. It contains no filler, and the examples earn their place by clarifying the parameter format.

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 a single-parameter, likely read-only tool with an output schema, this is nearly complete: the parameter is documented and the return type is stated. The main gap is not mentioning when to prefer this over the IPv6 sibling, but that is a minor omission for such a simple operation.

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 input schema only defines instance_id as a string with 0% description coverage. The description compensates well by identifying the accepted forms (ID, label, or hostname) and providing concrete examples, which is the key semantic information an agent needs.

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?

States a specific action ('List'), resource ('IPv4 addresses'), and scope ('for an instance'). It is clearly distinguishable from the sibling instance_list_ipv6 by address family, though it does not explicitly name that alternative.

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 explicit guidance is given about when to use this tool versus instance_list_ipv6 or instance_create_ipv4/instance_delete_ipv4. The intended usage has to be inferred from the tool name and the one-line purpose.

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