Update an issue

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

Annotations provide basic traits (readOnlyHint=false, destructiveHint=false) but add little beyond that. The description mentions the HTTP method and authorization class, which adds some value but does not disclose partial update behavior or 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 very brief (two sentences), but lacks critical information about parameters and usage. Conciseness is not helpful when it omits necessary 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?

Given the complexity of the input schema (many nested fields) and no output schema, the description is severely incomplete. It does not explain return values, required fields, or how to construct the body.

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%, and the description does not explain any of the body properties or the path parameter. The agent receives no guidance on what fields can be updated or their semantics.

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 updates an issue, which is a specific verb+resource. However, it does not differentiate from sibling tools like pc_get_issues or pc_delete_issues, which also relate to issues.

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 on when to use this tool versus other issue-related tools (e.g., pc_post_issues or pc_patch_issues_by_id alternatives). No prerequisites or conditions provided.

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