list_snapshots

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

Without annotations, the description fully carries the transparency burden. It discloses that snapshots are automatic, stored under a specific directory, and sorted newest first. It also details the return format. No side effects are needed for a read operation.

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 with no wasted words. It uses a docstring format with clear sections (Args, Returns, Example) and front-loads the purpose. Every sentence provides value.

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 simple listing tool with one parameter and no output schema, the description covers purpose, trigger, location, ordering, and return format, plus an example. It is practically complete, though it could mention that restore_snapshot is the complementary sibling.

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?

The single parameter 'project_root' is described as 'The project root the snapshots were taken under,' which adds meaningful context beyond the schema's generic 'Project Root' title. With schema description coverage at 0%, the description compensates well.

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 explicitly states 'List undo snapshots captured before risky commands, newest first.' This clearly defines the verb (list), resource (undo snapshots), and ordering. It distinguishes itself from siblings like restore_snapshot by focusing on listing.

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 explains that snapshots are taken automatically before medium-or-higher risk commands, giving clear context for when to use this tool. It does not explicitly state when not to use it, but the purpose is well-defined.

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