Update issue

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

Annotations already cover the safety profile (readOnlyHint=false, destructiveHint=false, openWorldHint=true). The description adds nothing beyond that: it doesn't state whether this is a partial update (unset fields preserved), what permissions are required, or the error behavior if the issue is missing.

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?

A single efficient sentence with the primary verb and target front-loaded. Zero filler; every word carries meaning.

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?

No output schema exists and annotations cover the safety profile, so the description only needs to cover behavior and params. It lists the mutable fields but omits partial-update semantics and auth needs, leaving a mutation tool minimally but not fully described.

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 coverage is only 38%, so the description partially compensates by naming five updatable fields (title, body, state, assignees, milestone). However, owner/repo/index and the semantics of a milestone integer are left unexplained, so the description helps but does not close the coverage gap.

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?

States a specific verb (Edit) and resource (issue) and enumerates the mutable fields, so the agent knows exactly what it changes. It is clearly distinct from create_issue and get_issue, though it doesn't explicitly name those alternatives.

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 when-to-use, prerequisites, or alternative routing is provided. The description never says when to prefer update_issue over related tools like add_issue_labels or update_pull_request, leaving usage entirely to inference.

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