post_issue_comment

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

Annotations declare destructiveHint=true, openWorldHint=true, and non-idempotent, which is significant for a tool that appends a comment. The description doesn't mention that this creates a permanent comment on an issue, cannot be undone via this tool, or any rate limits. It also doesn't note that the comment appears publicly or is tied to the authenticated user.

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?

Two short sentences, but the second is redundant with the first, wasting space. It is front-loaded with the main action, but the repetition reduces efficiency.

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 output schema, nested parameters, and annotations indicating destruction and open-world behavior, the description is too sparse. It doesn't explain the structure of the comment body, required authentication, or what happens on success. It leaves significant gaps.

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. It only vaguely references 'its unique identifier,' which maps to issueId, but doesn't explain the nested body.message structure or the 10000-character limit. It fails to add meaning beyond the schema's field names.

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?

States a clear verb+resource: 'Post a comment on an issue.' The second sentence just restates this with 'using its unique identifier,' adding no real clarity. The purpose is clear and distinguishable from siblings like post_test_case_comment or post_test_result_comment, but it doesn't call out that distinction.

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?

No guidance on when to use this tool versus alternatives like post_issue (creating an issue) or post_issue_attachment. There's no mention of prerequisites such as needing the issue to exist, nor any context about when commenting is appropriate.

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