Retrieve all disks attached to a specified machine by its ID through the VCF Automation IaaS API, enabling disk inventory and configuration checks.
Get machine disks Get all machine disks GET /iaas/api/machines/{id}/disks
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | The ID of the machine. (path) | |
| apiVersion | No | The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about |
Changes observed during successful MCP inspections.
v0.2.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly, idempotent, non-destructive and open-world, so the safety profile is covered. The description adds only a REST path, which duplicates the annotation title, and says nothing about pagination, ordering, or what a listed disk contains.
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?
Very short and front-loaded, but the first two lines restate the same thing and the third line restates the annotation title, so it is repetitive rather than dense with 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 list endpoint with full schema coverage and rich annotations, the description is minimally sufficient. A note on pagination behavior or the disk fields returned would close the remaining gap for an agent with no output schema.
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 coverage is 100%, with both id (machine ID, path) and apiVersion documented in the schema. The path '/machines/{id}/disks' reinforces that id is the machine identifier, but adds no syntax or format detail beyond the schema.
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 verb and resource ('Get all machine disks') and even names the endpoint, so intent is clear. It stops short of differentiating from the sibling iaas_get_machine_disk (single disk), which an agent must infer.
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 on when to use this versus iaas_get_machine_disk, iaas_get_machines, or the block-device tools. The agent must infer usage from the name alone.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.