createPullRequest

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

With no annotations provided, the description carries full burden. It only states 'Create a new pull request' without disclosing permissions required, side effects (e.g., notifications, branch locking), or mutation behavior. This is insufficient for safe agent invocation.

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?

Single sentence is concise but severely under-specified. It lacks structure such as bullet points or groupings for parameters, and front-loads no critical information. Conciseness here comes at the cost of completeness.

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?

Tool has 9 parameters, no output schema, and no annotations. The description fails to explain return values, validation rules, or behavioral expectations (e.g., sourceBranch should exist, targetBranch is base). This is inadequate for a complex creation operation.

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% coverage with descriptions for all 9 parameters. The tool description adds no extra parameter context, so baseline 3 is appropriate. It neither harms nor significantly helps beyond 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?

The description clearly states the verb 'Create' and the resource 'pull request', making the tool's primary function unambiguous. It also distinguishes from siblings like 'createDraftPullRequest' by implying this creates a non-draft PR.

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 guidance is provided on when to use this tool versus alternatives (e.g., createDraftPullRequest for drafts, mergePullRequest for merging). No exclusions or prerequisites are mentioned, leaving the agent to infer usage context.

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