Skip to main content
Glama

get_pr_status

Read-onlyIdempotent

Look up a pull request's merge-queue status by number or branch, including any associated batch bot PR.

Instructions

Merge-queue status of one PR, looked up by number OR branch (exactly one). Includes its batch (bot) PR, if any.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_pr_status"
  }
}

Input Schema

NameRequiredDescriptionDefault
orgNoGitHub org. Optional if repo is 'org/name'.
repoNoGitHub repo name or 'org/name'.
branchNoPR head branch.
numberNoPR number.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.2

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, non-destructive and open-world behavior, so the bar is lower; the description still adds real context by noting that the response includes the associated batch/bot PR, if one exists. It does not describe error behavior when the PR is absent from the queue, which keeps it from a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence that states subject, lookup keys, the exclusivity rule, and the notable payload inclusion. Nothing is redundant with the title or schema.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a four-parameter read-only status tool with no output schema, the description conveys what is fetched and the one behavioral wrinkle (bot PR inclusion). It stops short of saying what a status value looks like or what happens on a miss, but is otherwise sufficient to invoke correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds a constraint the schema does not express: exactly one of `number` or `branch` must be supplied (the schema shows no required fields and no oneOf/oneOf-style mutual exclusion). That materially changes how an agent fills the parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Names a specific verb and resource ('Merge-queue status of one PR') and bounds the scope to a single PR, which cleanly separates it from list_queued_prs and get_queue_stats. It further clarifies that the batch (bot) PR is folded into the result, which differentiates it from get_bot_pr, which presumably returns that PR alone.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies the use case (inspect one PR's queue state) and states the lookup constraint, but never says when to prefer this over siblings such as get_bisection_status or list_queued_prs, and offers no exclusions. Guidance is present but must be inferred.

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