Checkout Paperclip issue

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

Beyond the annotations (openWorldHint, idempotentHint, destructiveHint), the description discloses atomicity, lock-stealing prohibition, terminal 409 semantics, and the stale-reclaim recovery path. This adds meaningful behavioral context without contradicting any annotation. Minor gap: it does not state what the checkout returns or what state transition the issue undergoes.

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?

Three terse sentences, each earning its place: purpose, conflict handling, and parameter condition. The core purpose is front-loaded in the first clause, and there is zero filler or repetition of schema content.

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 moderate complexity, the essential calling knowledge is present: the required id, the precise meaning of reclaim_stale, the terminal 409 behavior, and a safety profile from annotations. Remaining gaps — no return-value disclosure and no elaboration on expected_statuses semantics — are minor but worth noting.

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?

With schema description coverage at only 33%, the description carries the burden for undocumented parameters. It compensates where it matters most: reclaim_stale has no schema description but is fully scoped here (true only when adopting your own stale in_progress checkout after a crash). expected_statuses is already covered by its schema description, and id is self-evident from the resource noun.

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 opens with a specific verb and resource: 'Atomically claim an issue for the current agent,' naming the operation, the object, and the actor scope. This clearly distinguishes checkout from siblings such as paperclip_issue_release (the inverse operation) and paperclip_issue_create without restating the title.

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 context is clear — this is the tool for claiming an issue before working on it — and it adds strong conditional guidance ('Set reclaim_stale=true only when adopting your own stale in_progress checkout after a crashed run') plus a failure rule (409 is terminal). However, it never routes to alternatives explicitly; nothing points to paperclip_issue_release for when work is complete, so when-to-use vs alternatives is only implied.

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