seerr_update_issuecomment

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

Annotations already indicate readOnlyHint=false and destructiveHint=false. The description adds 'WRITE: this modifies your Seerr instance,' but this essentially restates the annotation. It does not disclose side effects, required permissions, idempotency, or other behavioral nuances beyond the obvious write nature.

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 concise and front-loaded with the action. The 'WRITE:' prefix is somewhat redundant given the annotations, but it does not significantly detract. It is efficient, though the briefness borders on under-specification.

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 tool's complexity (nested object body, output schema), the description is minimal. It lacks usage guidance and parameter semantics. Even though an output schema exists, the description does not provide sufficient context for an agent to understand when and how to use the tool effectively.

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?

The input schema has 0% description coverage, and the description does not mention any parameters. 'comment_id' and 'body' are left unexplained, and the description fails to compensate for the lack of schema documentation. This is a critical gap for an agent to invoke the tool correctly.

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 states 'Update issue comment' which is a specific verb and resource, clearly distinguishing it from sibling tools like create/delete/get issue comments. The added 'WRITE: this modifies your Seerr instance' reinforces that it's a mutation operation, making the purpose unambiguous.

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 is provided on when to use this tool versus alternatives. It does not mention any prerequisites, contexts, or exclusions. The description only restates the action without offering selection criteria for an agent.

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