Create Checkpoint

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

With no annotations, the description carries the full burden and does well: it discloses that the user's project file is not touched, external data files/databases are not copied, uncommitted edits are excluded and surfaced under 'uncommitted_edits', and only the last 20 checkpoints persist until the server stops.

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 dense but efficient: the core purpose is front-loaded and each subsequent sentence adds a distinct behavioral caveat without filler.

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?

It covers what is captured, what is not captured, retention limits, and project-file impact, which is enough for a tool with one optional parameter and no output schema. It leaves minor ambiguity about checkpoint naming and the return value, but these are not critical.

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 schema has zero description coverage for the single optional 'name' parameter, and the description never explains naming behavior, uniqueness, or what happens when name is null. The property name gives only minimal implicit meaning.

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 states a specific action ('Snapshot the whole project'), details the exact contents captured, and mentions that restore_checkpoint can return to it, which clearly distinguishes it from list_checkpoints, restore_checkpoint, and save_project.

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?

It explicitly says to take a checkpoint before a sequence of changes you may want to undo and references restore_checkpoint as the counterpart. However, it does not contrast with save_project or explicitly state when not to use this tool.

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