Unlock an issue document

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

The description only mentions authorization class and HTTP method. Annotations indicate mutation (readOnlyHint=false) but non-destructive, yet the effect of unlocking is not described. No additional behavioral context beyond 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?

Two short sentences deliver the core purpose and technical reference without any fluff. Front-loaded and highly concise.

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?

While output schema exists, the description omits important context like side effects, preconditions, or return value meaning. Adequate but leaves gaps for an unfamiliar agent.

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 description does not explain the meaning of 'id' or 'key' parameters. Schema coverage is 50%, but the description provides no parameter details, leaving the agent to infer their roles.

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 tool unlocks an issue document, but does not differentiate from sibling tools like the lock counterpart, missing an opportunity to clarify its complementary role.

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?

No guidance is provided on when to use this tool versus alternatives (e.g., lock, update, delete). Prerequisites or context (e.g., document must be locked) are absent.

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