Reply in thread

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

Annotations already declare the write, open-world, non-idempotent, non-destructive profile. The description adds a genuinely useful behavioral fact beyond them: the note is visible to the reporter. It omits, however, that repeated calls will stack duplicate notes on the same thread (non-idempotent), which an agent would benefit from knowing.

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 front-loaded sentence with an inline example; nothing is wasted. The example arguably earns its place by showing expected message content.

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?

There is no output schema and only two simple required params, so the bar is modest, but a mutation tool with 0% param documentation should do more than state the intent: it never clarifies the commentId's origin or the effect of repeated replies.

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 must carry the burden, and it largely does not: commentId is never explained, and message semantics (the 1-5000 char limit, whether markdown is allowed) are only loosely hinted at by the example string.

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+resource (add a note to a comment thread) and gives a concrete example message. It does not differentiate itself from the sibling create_batch_note, which likely has an overlapping purpose, so it falls short of a 5.

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 phrase 'so the reporter can see what happened' implies the situation for using it, but there is no explicit when-not guidance and no routing to alternatives such as create_batch_note or update_status.

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