vcs_commit_checkpoint

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

The annotations already provide destructiveHint=true, indicating this is a mutating operation. The description adds minimal behavioral context beyond the annotation, such as what a 'checkpoint' entails or any side effects (e.g., running auto_drc). It does not contradict the annotations.

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 a single, concise sentence that front-loads the main action. Every word contributes to understanding the tool's purpose, with no filler or redundancy.

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 tool with two parameters, zero schema descriptions, and a destructiveHint annotation, the description is too sparse. It omits prerequisites (e.g., whether a Git repo must be initialized), the meaning/effect of auto_drc, and what happens to existing checkpoints. The existence of an output schema is noted but not enough to compensate for the lack of behavioral context.

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 0%, so the description must compensate for the lack of parameter documentation. The phrase 'named checkpoint' hints that 'message' is the name, but it says nothing about 'auto_drc' or how that affects the commit. This is a significant gap.

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 uses a specific verb 'Commit' with a clear resource 'current project state as a named checkpoint'. It effectively distinguishes this tool from siblings like vcs_restore_checkpoint, vcs_list_checkpoints, and vcs_diff_with_checkpoint, which have different actions.

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 implies the tool is used to save a checkpoint but provides no explicit guidance on when to use it vs. alternatives like vcs_restore_checkpoint or vcs_list_checkpoints. It lacks any mention of prerequisites or 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.