iaas_attach_machine_disk

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

Annotations already disclose that this is a non-read-only, non-idempotent, open-world, non-destructive mutation. The description adds little beyond the endpoint and a restatement of the tool name; it does not describe side effects, preconditions, or what happens to the disk after attachment.

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 two lines are redundant: 'Attach machine disk' and 'Attach a disk to a machine' convey the same information. The endpoint is useful, but the duplicate phrasing keeps it from earning a higher conciseness score.

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?

The tool is simple and the schema plus annotations cover much of the necessary structure. However, with no output schema, the description could do more to explain the expected outcome of attaching the disk and any important preconditions.

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 input schema already documents the machine ID, block device ID, and optional body fields. The description does not add parameter-level meaning beyond the schema, which is acceptable given the full schema coverage.

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 verb and resource: attach a disk to a machine, and includes the endpoint. It is clearly distinct from read siblings like iaas_get_machine_disks and delete siblings like iaas_delete_machine_disk, though it does not explicitly name the closest alternative, creating a block device.

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 says what the tool does but provides no guidance on when to use it versus alternatives such as iaas_create_block_device or iaas_get_machine_disks. It also omits prerequisites, such as the machine and block device needing to exist before attachment.

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