delete_branch

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 prominently warns that the action is permanent and cannot be undone, and it links to official docs for further details. However, it does not mention side effects on open pull requests, auth requirements, or failure conditions.

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 direct sentence followed by a documentation link. It states the action and its permanence without any wasteful wording, making it easy for an agent to parse quickly.

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?

For a simple three-parameter delete operation, the description covers the core purpose and includes a crucial warning plus a documentation link. It does not explain return values or error scenarios, but the docs link mitigates this, and the operation is straightforward.

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 already provides complete descriptions for all three parameters (owner, repo, branch), including the important note about the branch parameter lacking the refs/heads/ prefix. The tool description adds no extra meaning beyond what the schema already conveys.

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 uses a specific verb 'Delete' with a clear resource 'branch from a GitHub repository', distinguishing it from sibling tools like create_branch and get_branch. It also emphasizes the permanent nature of the action, leaving no ambiguity about its function.

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 usage is implied rather than stated explicitly: one should use this tool when wanting to remove a branch. It does not mention exclusions such as not deleting the default branch or requiring specific permissions, nor does it reference alternative approaches.

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