get_snapshot
Get a single snapshot with full body and diff
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | Project ID | |
| snapshotId | Yes | Snapshot ID |
Get a single snapshot with full body and diff
| Name | Required | Description | Default |
|---|---|---|---|
| projectId | Yes | Project ID | |
| snapshotId | Yes | Snapshot ID |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations provided, the description carries the burden of behavioral disclosure. It discloses that the tool returns the full snapshot body and a diff, which is meaningful behavioral detail for a read-only getter. It does not cover error behavior or diff direction, but the core behavior is clear.
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 a single sentence with no wasted words. The most decision-relevant information — single snapshot, full body, and diff — is front-loaded and compact.
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 tool with two required parameters, the description adequately states what is returned and that it targets a single snapshot. However, since there is no output schema, a bit more context about the diff semantics or return shape would make it fully self-sufficient.
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 baseline is 3. The parameter descriptions ('Project ID', 'Snapshot ID') are minimal and mostly restate the parameter names, and the tool description adds no additional parameter-level meaning 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?
The description uses a specific verb ('Get') and resource ('snapshot'), and the phrase 'single snapshot with full body and diff' clearly distinguishes it from siblings like list_snapshots. An agent can understand exactly what this tool does without opening the schema.
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 clearly implies this tool is for retrieving one specific snapshot rather than listing many, which gives useful context for choosing between get_snapshot and list_snapshots. However, it does not explicitly name alternatives or state when not to use it.
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.