bitbucket_pull_request_comment_create

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

Annotations are all false (readOnlyHint, idempotentHint, destructiveHint), so they provide no behavioral insight. The description compensates by disclosing the pending/invisible state and the condition for visibility (submitting a review). This is a key behavioral trait beyond what annotations offer, though it does not cover other aspects like reversibility or authentication requirements. Given the annotation void, the description adds substantial transparency.

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, focused sentence that front-loads the core action and its key behavior. There is no fluff or redundant information, making it efficient for an agent to parse.

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 6 parameters, no output schema, and the description is minimal. It does not explain the workflow (e.g., that a review must be submitted for the comment to appear), does not clarify ambiguous parameters, and provides no insight into return values or side effects. For a create operation with several undocumented parameters, this is insufficient for reliable invocation.

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 description provides no parameter-level guidance. Schema coverage is only 33% (repoSlug and workspace have descriptions; id, body, inlineLine, inlinePath do not). The description fails to compensate for the missing meanings of id (presumably the pull request ID), inlineLine/inlinePath (for inline comments), or how body is used. With low schema coverage, the description should have clarified these, but it does not.

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), the resource (pull request), and a distinguishing trait (pending, invisible to others until review submission). This differentiates it from sibling tools like bitbucket_pull_request_comment_list and other PR operations, making the purpose unambiguous.

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 clear context: it's for adding a pending comment that becomes visible only after the user submits a review in Bitbucket's UI. However, it does not explicitly mention alternatives or exclusions (e.g., if a visible comment is needed, use a different tool). Since no direct alternative exists among siblings, the lack of explicit routing is acceptable, but the guidance is still somewhat implied rather than stated.

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