post_comment

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, but it only states the action without explaining side effects, permission requirements, or non-obvious API behavior. It does not mention that post_comment is a write operation with potential notification consequences, nor does it clarify behaviors like appending to an existing thread.

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, focused sentence with no filler. The key action and target are front-loaded, making it easy for an agent to quickly parse the tool's purpose.

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 four-parameter write tool with an output schema, the description is minimally adequate: an agent can likely infer how to call it. However, it lacks usage guidance, behavioral caveats, and parameter clarifications, so it is not fully self-sufficient.

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% and the description adds no parameter-level meaning beyond the obvious names owner, repo, issue_number, and comment. The description does not clarify formats, required comment content, or that issue_number can also identify a pull request in GitHub's API.

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 names a specific verb ('Post') and a concrete resource ('a comment on an issue or pull request'). This clearly conveys what the tool does and distinguishes it from sibling issue operations like add_labels, assign_issue, close_issue, and reopen_issue.

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 intended use is implied by the verb and target: use this tool when you need to add a comment to an issue or pull request. However, the description gives no explicit guidance about when not to use it, nor does it mention any alternatives or prerequisites such as required permissions or issue state.

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