Retrieve snapshot information for a specific machine ID to review available snapshots and support recovery or change planning.
Get machine snapshots information GET /iaas/api/machines/{id}/snapshots
| 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?
The annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=true, and destructiveHint=false. The description adds no behavioral context beyond the endpoint path, which duplicates the annotation title, and says nothing about return format, pagination, permissions, or scope. It does not contradict the annotations.
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, with the main operation stated first and the endpoint second. The endpoint line is somewhat redundant with the annotation title, but the description remains efficient and easy to scan.
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 low-complexity GET tool with full schema coverage and clear safety annotations, the description identifies the resource adequately. However, with no output schema, it does not clarify the return shape, and it does not distinguish this plural snapshot listing from the singular snapshot sibling, leaving a modest completeness gap.
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%, with the required id parameter documented as the machine ID path parameter and apiVersion documented separately. The description adds no additional parameter semantics beyond what the schema already provides, so the baseline of 3 applies.
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 clear verb and resource: 'Get machine snapshots information,' reinforced by the REST endpoint. It is understandable, but it does not explicitly distinguish this plural snapshots retrieval from sibling tools such as iaas_get_machine_snapshot or iaas_get_disk_snapshots.
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 offers no guidance on when to use this tool versus alternatives, nor any exclusions or prerequisites. It only restates the operation and endpoint path, leaving the agent to infer its place among many snapshot-related siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.