merge_branch

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

With no annotations, description carries full burden. It states the merge action and return type but does not disclose side effects (e.g., overwriting, permissions needed, conflict handling). Minimal behavioral context.

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?

Description is concise and includes a clear list of arguments and return value. It is front-loaded with the main action. A few words could be trimmed, but overall 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?

Given the tool's complexity (merge operation), missing annotations, and no schema descriptions, the description provides parameter explanations and return type but lacks preconditions, error scenarios, and behavioral details. Adequate but with clear gaps.

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 0%, but description compensates by naming each parameter and adding format constraint (<username.branch_name>). Provides basic meaning for source_ref, into_branch, commit_message, and commit_body, adding value beyond the bare 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 merges a source branch into a target branch, specifying the resource (Bauplan data catalog) and action. However, it does not differentiate from sibling tools like create_branch or delete_branch, leaving some ambiguity.

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?

No explicit guidance on when to use this tool versus alternatives. Mentions branch name format but lacks context such as prerequisites (branches must exist) or conflict scenarios. No reference to sibling tools.

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