Retrieve a specific snapshot by id
retrieveSnapshotRetrieve a specific snapshot by id - Get all attributes for a specific snapshot
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| snapshotId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes |
retrieveSnapshotRetrieve a specific snapshot by id - Get all attributes for a specific snapshot
| Name | Required | Description | Default |
|---|---|---|---|
| instanceId | Yes | ||
| snapshotId | Yes | ||
| x-trace-id | No | ||
| x-request-id | Yes |
Changes observed during successful MCP inspections.
Input schema / properties / x-hapi-auth-stateRemoved value: -{
- "type": "string"
-}Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is clear. The description adds that it retrieves 'all attributes', which is useful but minimal. No additional disclosure of errors, rate limits, or auth requirements is given.
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 extremely concise and front-loaded, with no wasted words. It effectively states the core purpose in one sentence, though brevity comes at the cost of detail.
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?
Given the tool has 4 parameters (3 required), no output schema, and no parameter descriptions, the description is inadequate. It does not explain the instance/snapshot relationship, required headers, or return structure. This is a clear under-specification for an API of this complexity.
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 0%, so the description must explain parameters. It only says 'by id' without clarifying that both instanceId and snapshotId are required, or the purpose of x-request-id. This is a significant gap for a 4-parameter tool.
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 clearly states the verb 'Retrieve' and resource 'specific snapshot by id', distinguishing it from retrieveSnapshotList (list) and mutation tools like rollbackSnapshot, updateSnapshot, deleteSnapshot. The title reinforces this.
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 phrase 'by id' implies usage when a specific snapshot id is known, but no explicit when-to-use vs alternatives (e.g., retrieveSnapshotList) is provided. Sibling names hint at distinctions, but the description does not state exclusions or alternative scenarios.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.