issue_comment

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

No annotations are provided, so the description carries the full behavioral burden, yet it never says this creates an immutable comment (append-only mutation), what it returns, or whether commenting on closed issues fails. The only disclosed trait is that body content is interpreted as markdown, which is thin for an unannotated write tool.

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?

One short, front-loaded sentence with zero redundancy or filler. It is efficient, though its brevity is partly under-specification rather than disciplined concision.

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?

For an unannotated mutation tool with no output schema and one undocumented third parameter, the definition omits return shape, failure conditions, and permission requirements. An agent could invoke it but could not predict outcomes or handle errors from the description alone.

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 67% and the two documented parameters ('Issue key or URL', 'Site name or host') are already explained in the schema. The description's only added meaning is that the 'markdown' parameter is a markdown-formatted body, a marginal but real clarification beyond the bare string type.

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 a specific verb and resource ('Comment on an issue') plus the content format ('markdown'), which is enough to separate it from page_comment and read tools like issue_get. It does not explicitly name the sibling it contrasts with, so it stops short of full differentiation.

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 versus page_comment, issue_update, or issue_transition, and no prerequisites such as required permissions or issue state. The agent must infer the choice from the resource noun alone.

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