create_issue_comment

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

With no annotations, the description carries the full burden of behavioral disclosure. It indicates a mutating action ('Add') but does not mention permissions, idempotency, whether the comment is permanent, or what side effects occur. It mostly restates the intended purpose rather than revealing operational behavior.

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 concise sentence with no filler, redundancy, or unnecessary detail. It is front-loaded with the core action and resource.

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 mutation tool with no annotations and zero parameter descriptions, this is under-specified. The output schema reduces the need to explain return values, but the ambiguous 'index' parameter and lack of usage context leave enough gaps that an agent may not invoke it correctly.

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 compensate for parameter meaning, but it does not define owner, repo, index, or body. While owner/repo/body are somewhat self-explanatory, 'index' is ambiguous and never clarified as the issue or pull request number.

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 ('Add') and resource ('a comment to an issue or pull request'), making the action and target clear. It also naturally distinguishes this tool from sibling list/edit/delete comment tools.

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 use when you want to create a new comment on an issue or PR, but it does not explicitly state when to prefer this over edit_issue_comment, delete_issue_comment, or create_pull_review. No exclusions or alternative routing guidance is provided.

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