github_create_issue_comment

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

With no annotations, the description must disclose behavioral traits, but it is minimal. It does not mention that this is a write operation (though 'Add' implies it), any authentication requirements, session prerequisites, or potential side effects. The description carries a low burden for a mutation tool, leaving significant transparency gaps.

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: a single sentence followed by a compact Args list. It is front-loaded with the main purpose and contains no filler or verbosity. It could be slightly more structured (e.g., using a formatted list), but it remains efficient and easy to scan.

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 CRUD tool, the description provides the core action and arguments, but it omits important context like authentication requirements (addressed by 'session_name' but not explained), the need for a pre-existing issue, and what the output will be. The output schema exists, so return values need not be described, but behavioral prerequisites are still missing, making the tool incomplete for an agent to invoke reliably.

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 has zero description coverage, so the Args block in the description is the only source of parameter meaning. It lists all five parameters but adds little depth—'Repository owner', 'Repository name', and 'Issue number' restate the names. Only 'body' (markdown supported) and 'session_name' (which session) add useful context. This is marginal but compensates slightly for the lack of schema descriptions.

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 clearly states the tool's function with a specific verb and resource: 'Add a comment on an issue.' This is unambiguous and distinguishes it from PR comment creation via the word 'issue.' However, it does not explicitly differentiate from sibling tools like github_create_pr_comment, so it lacks explicit sibling 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?

The context of 'add a comment on an issue' makes the usage scenario clear. However, there is no mention of when not to use this tool (e.g., for pull request comments) or any prerequisites like needing an existing issue or an active session. The guidance is implied rather than explicit.

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