bitbucket_add_pull_request_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. It does mention that the tool returns a JSON string with created comment details and raises ValueError if the client is not configured, which adds useful context. However, it does not disclose permission requirements, whether the comment is appended as a general comment rather than inline, or any other side effects.

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 concise and well-structured with a clear one-line summary followed by Args, Returns, and Raises sections. It avoids unnecessary fluff, though the Args list is redundant with the schema, keeping it from being maximally efficient.

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 input schema fully covers all four parameters and the description mentions return and error behavior, so basic usage is sufficiently specified. However, the lack of usage guidance, alternative differentiation, and permission context leaves gaps for a complete picture, especially given that no annotations are present to fill in safety or auth details.

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 input schema has 100% parameter description coverage, and the Args section in the description merely repeats the same names and one-line descriptions without adding extra meaning. Since the schema already documents all parameters clearly, the description provides no additional semantic value.

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 'Add a comment to a pull request,' which is a specific verb and resource. However, it does not explicitly differentiate from sibling tools like bitbucket_add_pull_request_blocker_comment or bitbucket_add_pull_request_inline_comment, so it misses the full distinction expected for a 5.

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?

There is no guidance on when to use this tool versus the blocker or inline comment variants, nor any mention of prerequisites, permissions, or context. The description only states what the tool does, offering no decision-support for an AI agent choosing among similar tools.

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