snapshot_diff_summary

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

With no annotations, the description carries the full burden, and it does disclose the main output behavior: a one-paragraph summary with counts and first few changed tracks. Missing details are the meaning of 'first few' (limit), whether the tool mutates anything, and how response_format alters prose vs json.

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?

Two sentences, front-loaded with the core function before the companion tool guide. Every sentence earns its place, and the snapshot guide is compact enough to keep the overall description scannable.

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 3-parameter tool with no output schema, the description communicates purpose, output shape, and the broader snapshot toolset. It falls slightly short of full completeness because it doesn't describe response_format's behavioral variants or a snapshot reference format (id, filename, path), though those are in the schema.

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 schema already documents older/newer snapshot ids and response_format options. The description reinforces the duality of from_snapshot/to_snapshot by saying 'differences between two snapshots', but adds no syntax or format detail 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?

Description opens with a specific verb phrase and resource: 'One-paragraph summary of the differences between two snapshots'. It also names the exact output ('counts plus the first few changed tracks'), which clearly distinguishes it from sibling diff tools like diff_playlist_snapshots and snapshot_new_tracks.

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 'Snapshot guide' sentence explicitly maps snapshot operations to sibling tools (create/list/read/diff/restore), giving the agent a workflow context and alternatives. It does not explicitly state 'use this when you need a concise overview instead of a raw diff', but the output description implies the selection criterion.

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