Update Issue Comment

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

With only readOnlyHint: false in annotations, the description carries the burden of behavioral disclosure. It doesn't mention whether the comment is fully replaced, if permissions are required, or any side effects beyond updates. The summonees tip is more about parameter usage than operational behavior.

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 two sentences, immediately stating the purpose and then providing a key usage tip. Every word earns its place with no redundancy.

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?

Although the output schema covers return values, the description provides minimal context for a mutation tool. It doesn't clarify if the update replaces the entire comment, any prerequisites, or potential side effects beyond notifications. It is adequate but leaves 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 coverage is 100%, so the baseline is 3. The description reinforces the summonees parameter's purpose but doesn't add significant new meaning beyond the schema descriptions already present.

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 'Update an existing comment in a Yandex Tracker issue', using a specific verb and resource. It distinguishes from siblings like issue_add_comment and issue_delete_comment by focusing on the update action on an existing comment.

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 gives clear context for when to use the tool (updating an existing comment) and includes the IMPORTANT tip about using the summonees parameter for notifications. It doesn't explicitly mention alternatives, but the context is clear with no exclusions.

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