bb_get_pull_request_comments

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. It states the operation is a read (Get) and mentions it returns both general and inline comments. However, it does not disclose any behavioral traits such as authentication requirements, rate limits, or potential errors. It is adequate but not comprehensive.

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 short and front-loaded with the purpose. The Args list is structured but slightly redundant with the schema. It is concise with no unnecessary sentences.

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?

Given the tool's simplicity (3 parameters, read-only operation) and the presence of an output schema, the description provides sufficient context. It explains the purpose and parameters well, but could optionally mention pagination or sort order if applicable.

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% description coverage, so the baseline is 3. The description's parameter explanations largely repeat the schema's descriptions (e.g., defaults to environment variables). It adds no new meaning beyond what is already defined in the schema.

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?

Clearly states it gets the review discussion on a Bitbucket PR, including both general and inline comments. The verb 'Get' and resource 'review discussion' are specific, and the tool is distinct from siblings like bb_get_pull_request_diff and bb_get_pull_request_status.

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 implies usage for fetching comments, but does not explicitly state when to use this tool versus alternatives like bb_get_pull_request for PR details or bb_get_pull_request_diff for diffs. No when-not or alternative guidance is given.

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