comment_on_issue

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It does reveal that the action posts publicly and advises confirmation, which is a meaningful behavior. However, it omits other relevant aspects such as authentication requirements, whether the action is reversible, or any side effects on the issue. It is better than nothing but still incomplete 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 a single, front-loaded sentence that states the action and the key caveat. There is zero waste, and the critical warning ('confirm first') is included. It is as concise as possible while conveying essential information.

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 tool, the description covers the core action and a notable behavioral note. Since an output schema exists, return values are not needed. The description does not mention error conditions or authentication, but given the tool's simplicity and the presence of a schema, it is largely sufficient. A slight gap is the lack of guidance on the optional repo parameter's behavior, but that is minor.

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 100%, with each parameter having a clear description (e.g., 'Markdown comment.', 'Repository as owner/name.', 'The issue number.'). The tool description does not add any extra semantic meaning beyond what the schema already provides. Since the schema fully documents the parameters, the baseline of 3 is appropriate.

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 clear verb ('Add'), a specific resource ('a comment'), and a target ('an existing issue'). This unambiguously differentiates it from sibling tools like create_issue, list_issues, or search_issues. The purpose is immediately understandable and not a tautology.

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 through its clear purpose, but it does not explicitly state when to use it versus alternatives, nor does it provide exclusions or when-not-to-use conditions. The 'confirm first' is a cautionary note but not a usage guideline. Sibling tools are distinct enough that a misroute is unlikely, but explicit guidance is missing.

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