add_checkpoint

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

No annotations are provided, so the description carries the full disclosure burden. It reveals one behavioral trait: if no position is given, the checkpoint is appended at the end. However, it omits other important behavioral details such as permissions required, side effects on the milestone, or whether the operation is reversible. For a mutation tool, this is a partial disclosure.

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 core purpose and includes the key optional behavior. Every word earns its place, with no redundancy or excess detail.

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?

Despite having 9 parameters and no annotations or output schema, the description is only one sentence. It fails to mention prerequisites (e.g., milestone existence or permission requirements), return values, or edge cases around the complex dependencies parameter. The tool is non-trivial, and the description is too minimal to be fully complete.

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 description adds a small clarification that the milestone must already exist ('existing milestone'), but it mostly repeats the position parameter's schema description (if not provided, appends at end). It does not significantly enhance parameter understanding 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?

The description clearly states the action: 'Add a new checkpoint to an existing milestone.' This uses a specific verb ('add') and resource ('checkpoint') with a clear target ('existing milestone'), distinguishing it from sibling tools like create_milestone, update_checkpoint, or delete_checkpoint.

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 provides clear context by noting the checkpoint is added to an existing milestone and that position is optional (appended if not specified). It implies the tool is used for inserting new checkpoints into a milestone, but it does not explicitly mention alternatives or exclusions (e.g., 'use update_checkpoint to modify an existing checkpoint').

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