add_comment

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

With no annotations and only a six-word description, behavioral traits such as whether the comment is appended, limits, or error handling are completely absent. The description adds no value beyond the tool's name.

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?

At 6 words, the description is extremely concise but lacks structure; it could include more information without sacrificing brevity.

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?

The tool has 5 parameters (3 required) and no output schema. The description fails to explain return values, error conditions, or how to use the parentId parameter. It is insufficient for complete understanding.

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 parameter schema already has 100% coverage with descriptions for all parameters. The description does not add any further meaning or context about how parameters interact, so baseline 3 applies.

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 'Add a comment to a pull request' clearly states the verb 'Add' and the resource 'comment to a pull request', which is specific and distinct from sibling tools like add_inline_comment or approve_pull_request.

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 like add_inline_comment or other PR actions. No prerequisites or context for effective use are mentioned.

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