update_workitem_comment

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

Annotations already declare destructiveHint=true and idempotentHint=true, so the safety profile is known from structured data. The description adds nothing beyond them: it does not say whether the update replaces the entire comment body or merges, whether the previous text is recoverable, or whether ownership is required — all material for a destructive mutation.

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?

It is one short, front-loaded sentence with no wasted words, but the brevity is under-specification rather than economy — the only sentence present conveys little beyond the tool name.

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?

An output schema exists, so return values need no explanation, but for a destructive mutation of a comment in a shared project the definition should cover replacement semantics, permissions, and the enumeration parameter. With 0% schema coverage and no behavioral detail, the definition is incomplete for its complexity.

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%, so the description carries the full burden for four parameters, yet it mentions none of them. It does not explain the format_type enum (MARKDOWN vs RICHTEXT), the workitem_id pattern, or the fact that content is a full replacement of the comment body.

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 single sentence gives a specific verb and resource (修改...一条评论 = modify one comment) scoped to the current project, which separates it from create_workitem_comment and delete_workitem_comment. It stops short of naming those siblings or any distinguishing scope detail, so it is clear but undifferentiated beyond the verb.

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?

There is no guidance on when to use this tool versus the sibling comment tools, no prerequisite or permission conditions, and no statement about what it takes to edit someone else's comment. The agent must infer everything from the verb alone.

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