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 only states the action without revealing any side effects, idempotency, authentication requirements, rate limits, or response behavior. There is no mention of whether comments are appended, replaced, or require specific permissions, leaving significant ambiguity for an agent.

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 that directly states the tool's purpose. It contains no filler or redundant phrasing. Although brief, it efficiently communicates the core function without wasting words.

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, no output schema, and an underspecified parameter list, the description is too sparse. It does not explain return values, error conditions, or the context of when comments are appropriate. The simple one-liner is insufficient to fully support an autonomous agent in correctly invoking the tool and interpreting outcomes.

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 does not explain any of the four parameters. The schema lists parameter names and types but lacks descriptions. The description offers no insight into the meaning of 'body', 'issue_number', 'owner', or 'repo', leaving the agent without sufficient information to construct a correct request.

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 action: 'Add a comment to an issue or pull request'. It uses a specific verb ('Add') and resource ('comment to an issue or pull request'), which unambiguously differentiates it from sibling tools like create_issue or update_issue. It also correctly broadens the scope to pull requests, matching the tool's name.

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 provides no guidance on when to use this tool versus alternatives. It does not mention any prerequisites, exclusions, or examples of appropriate use cases. While the operation is straightforward, the tool could be chosen over update_issue or other comment-related actions, but no such differentiation is given.

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