List Snapshots

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

The description is fully consistent with the readOnlyHint annotation: both indicate a read-only operation (list/get). It explicitly describes the action as listing and retrieving, with no side effects or contradictions, and the annotation reinforces the safety profile.

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 concise, using two sentences to convey the core functionality and the optional parameter behavior. No unnecessary words or repetition; it gets straight to the point.

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 simple read-only nature and the clear parameter descriptions, the description provides all necessary context for an agent to invoke the tool correctly. It mentions the required project context, the main function, and the special case for snapshotId—sufficient for correct usage.

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?

All three parameters (skip, take, snapshotId) are described in the schema with clear meanings: pagination controls for skip/take and a filter for snapshotId. The description additionally explains that snapshotId returns a single snapshot, fully covering each parameter's purpose.

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 primary action ('List') and resource ('data snapshots'), and distinguishes this tool from sibling list tools by specifying the snapshot resource. It also clarifies the optional single-snapshot retrieval behavior, leaving no ambiguity about what the tool does.

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 'Requires project context' provides a clear prerequisite for use. Since sibling tools are all distinct resources (e.g., projects, environments, tags), no alternative selection guidance is necessary—the resource name alone is sufficient to route correctly.

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