Skip to main content
Glama

x_snapshot_read

Read-onlyIdempotent

Read a local snapshot by UUID to get its included records and any coverage warnings, so you can verify data completeness before analysis.

Instructions

Read a local snapshot by its UUID, including records and coverage warnings.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive behavior. The description adds useful context by stating that this reads a local snapshot and that the result includes records and coverage warnings, which goes beyond the structured annotations without contradicting them.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single sentence front-loads the action and resource, then adds the most important return detail. Every word contributes meaning, with no redundancy or fluff.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple one-parameter read operation with strong annotations, the description is sufficient to select and invoke the tool correctly and to know what the result contains. It could be more complete by explicitly noting that x_snapshot_list can be used to discover snapshot UUIDs, but that is not essential to correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There is only one parameter, id, and the schema merely specifies UUID format. The description clarifies that the id is the UUID of the local snapshot being read, which provides the necessary conceptual mapping and compensates for the 0% schema description coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific action (read), a resource (local snapshot), and a selector (UUID). Also indicates the contents returned (records and coverage warnings), which distinguishes it from siblings like x_snapshot_list and x_snapshot_compare at a glance.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies use when you have a specific snapshot UUID and need its contents, but it never explicitly says when not to use this tool or points to alternatives like x_snapshot_list or x_snapshot_compare. An agent must infer the routing from the sibling list rather than from the description.

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