Skip to main content
Glama

git_pr_readiness_check

Check for uncommitted files, unpushed commits, and branch health to ensure your repository is ready before opening a pull request.

Instructions

Verifies uncommitted files, unpushed commits, and branch health before opening a Pull Request

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior2/5

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. While 'verifies' implies a read-only check, it does not explicitly state that the tool makes no modifications to files or commits, nor does it describe what it returns or how errors are handled. This is a meaningful gap for a tool that could be expected to perform side-effect-free checks.

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?

The description is a single, well-structured sentence. It front-loads the key actions (verifies uncommitted files, unpushed commits, branch health) and the context (before opening a PR) with no wasted words.

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

Completeness3/5

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

The description tells what the tool does and when to use it, but it does not describe the output format or what constitutes 'branch health' beyond vague terms. Since there is no output schema, the agent is left unsure what the tool returns (e.g., a boolean, a report, a list of issues). For a simple no-parameter check, this is a notable completeness gap.

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?

The tool has zero parameters and 100% schema coverage (vacuously), so there is nothing for the description to add beyond the schema. The baseline for 0 parameters is 4, and the description is silent on parameters, which is appropriate.

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?

The description clearly states the tool's purpose: it verifies uncommitted files, unpushed commits, and branch health before opening a PR. The verb 'verifies' and specific resources distinguish it from sibling tools like git_generate_changelog or git_generate_pr_description, which generate artifacts rather than assess readiness.

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

Usage Guidelines4/5

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

It gives a clear temporal context ('before opening a Pull Request') that tells the agent when to use it. However, it does not explicitly name alternative tools or state when not to use this tool versus others, such as git_generate_changelog or doctor_check_env, so it stops short of full routing guidance.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ieeecsopen/mcp-cs'

If you have feedback or need assistance with the MCP directory API, please join our Discord server