iaas_get_machine_network_interface

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

The annotations already declare the safety profile: readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true. The description adds no behavioral context beyond restating the endpoint, such as authorization requirements, error behavior, or what the returned interface data includes.

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 short and front-loaded, but the first line repeats the tool name and the second sentence largely repeats the endpoint path. It could be tightened without losing information.

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 simple read-only lookup by two required IDs, the description is minimally sufficient and the annotations cover the safety profile. However, without an output schema, it does not explain what fields the returned network interface object contains.

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 the schema already explains id, networkId, and apiVersion. The description confirms that the interface is tied to a specific machine and network interface ID, but it adds no syntax or format details beyond the schema baseline.

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 names a specific verb and resource: retrieve a network interface for a given machine. It is clear what the tool returns conceptually, but it does not differentiate this tool from the many sibling read/get tools beyond the resource name.

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 provides no guidance on when to use this tool versus alternatives such as iaas_get_machine, iaas_get_network, or iaas_get_load_balancer_network_interface. It also omits prerequisites such as whether the machine and network interface must already exist.

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