add_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 burden. It discloses only the action and arguments, but omits behavioral traits such as required permissions, side effects (e.g., notifications), HTML sanitization, or return behavior. This is a significant gap for a mutation 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?

The description is concise and well-structured: a single purpose sentence followed by a clear parameter list. Every sentence adds value, and no unnecessary information is provided.

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 a simple mutation with three parameters, the description covers the purpose and parameters adequately. However, the presence of an output schema and absence of annotations mean the description could provide more context about expected behavior or side effects. It is functional but lacks some contextual depth.

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 schema contains only field titles with no descriptions (0% coverage). The description compensates by explaining each parameter: project_id and issue_id are UUIDs, and comment_html is HTML content. This adds meaningful semantic context beyond the schema.

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 the exact action 'Add a comment to a specific issue' with a clear verb and resource. This clearly distinguishes it from sibling tools like get_issue_comments (read) and create_issue (issue creation).

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 implies usage: use it when you want to add a comment to an issue. However, it provides no explicit guidance on when not to use it, nor does it mention alternatives like get_issue_comments for reading comments. The context is clear but lacks exclusion criteria.

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