bb_add_pull_request_comment

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

No annotations are provided, so the description must carry the full burden of behavioral disclosure. It does not mention side effects, permissions required, or return value. For a mutation tool, this is a significant gap. The agent cannot know if this is safe or what happens on failure.

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 sentences, no wasted words. The first sentence states the main purpose, and the second adds a specific use case. Well front-loaded and concise.

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 description explains the core functionality and two optional features. However, it does not discuss behavior when both parent_id and inline are set, what happens if inline_path is missing inline_line, or the role of the workspace parameter. For 7 parameters and no output schema, more detail would help.

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 coverage is 100%, so baseline is 3. The description adds meaning by explaining inline comment parameters ('on a specific file and line') and the parent_id for threaded replies. This clarifies the optional usage of inline_path, inline_line, and parent_id beyond 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 it adds a comment to a pull request, with optional inline commenting. It distinguishes from siblings like bb_comment_issue (for issues) and bb_approve_pull_request. The verb 'Add' and resource 'pull request comment' are specific.

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 gives guidance on using parent_id for threaded replies and implies inline commenting via inline parameters. However, it does not explicitly exclude usage for issues or compare with sibling tools like bb_comment_issue. Context from siblings makes the domain clear, but could be more explicit.

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