publishDraftPullRequest

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

No annotations are provided, so the description carries the full behavioral burden. It does disclose the core state change ('mark it as ready for review'), but it omits any additional behavioral context such as permissions, idempotency, whether the operation can be reversed, or what happens if the pull request is already non-draft.

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 concise sentence with no filler. The parenthetical adds immediate clarifying value without redundancy, and the core action is front-loaded.

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?

With three parameters, no annotations, no output schema, and a rich set of sibling tools, this description is too thin. It explains what the tool does but not the prerequisites (e.g., the PR must be a draft), the roles of the location-related parameters, expected return values, or error behavior, leaving significant gaps for an agent choosing and invoking the tool.

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 description coverage is only 33%, with only pull_request_id documented. The description adds no parameter-level detail and does not compensate for the undocumented repo_slug and workspace fields, leaving their meaning and optionality ambiguous for the agent.

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 and resource ('Publish a draft pull request') and the parenthetical clarifies the exact operation ('mark it as ready for review'). It clearly distinguishes this from the sibling createDraftPullRequest and convertToDraft by stating the direction of the state change.

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 when to use the tool: an existing draft pull request should be marked ready for review. However, it does not explicitly state alternatives, exclusions, or the typical workflow context, so the agent must infer the intended usage from the action itself.

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