Check out an issue

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

Annotations indicate this is not read-only, not idempotent, and not destructive, but the description adds minimal behavioral context beyond stating the endpoint and authorization class. It does not explain what checking out does to the issue (e.g., locking, preventing edits) or any side effects.

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 short with two sentences, but the second sentence is technical (endpoint and auth class) and does not add value for the agent. It is concise but lacks informative structure.

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 mutation tool with 2 required parameters, nested objects, and an output schema, the description is inadequate. It does not explain the purpose of the output, the meaning of expectedStatuses, or the effect of the operation, leaving significant gaps.

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%. The description does not explain any of the parameters, such as agentId (which agent is checking out) or expectedStatuses (what statuses are required). The agent cannot infer parameter meaning from the description alone.

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 title and description clearly state 'Check out an issue', which is a specific verb-resource combination. However, it does not differentiate this tool from siblings like pc_patch_issues_by_id or pc_post_issues_by_id_release, which could also involve issue state changes.

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 no guidance on when to use this tool versus alternatives, such as when to check out vs. release an issue. No context on prerequisites or scenarios is given.

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