Skip to main content
Glama

release_ready

Verifies project guardrails before tagging or deploying, returning whether a commit can ship plus blocking reasons, warnings, and guardrail decisions.

Instructions

May this commit be shipped? Asks the project's guardrails at the pre_release hook. Returns ready (false when a guardrail blocks, cannot be reached, or the project or commit is missing), reasons (a sentence for each thing holding the release back), warnings (shown, not blocking) and guardrails (each guardrail's decision). Call it before tagging or deploying and stop when it is not ready. repo is owner/name, milestone the milestone being shipped, merged_prs the pull requests in it (owner/repo#12). It changes nothing.

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": "release_ready"
  }
}

Input Schema

NameRequiredDescriptionDefault
repoNo
commitNo
projectNo
milestoneNo
merged_prsNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.59.0

TDQS

A3.9/5.0
Behavior4/5

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

With no annotations supplied, the description carries the full burden and does well: 'It changes nothing' declares read-only, and 'ready' is documented as fail-closed (false when a guardrail blocks, cannot be reached, or the project/commit is missing), which is important non-obvious behavior. It omits permission/auth requirements and whether guardrail evaluation is expensive or rate-limited, and some of the return-field enumeration duplicates the existing output schema.

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

Conciseness4/5

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

Front-loaded with the core question and the mechanism, then usage, then return semantics, then parameter formats — a sensible order. A few clauses (the guardrails-per-decision note) restate what the output schema already conveys and could be trimmed.

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 mutating-looking check, the description covers what it does, when to call it, that it is non-mutating, and its failure semantics; the output schema already documents return values. The main gap is the meaning of the commit and project parameters, which an agent must guess when supplying them.

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

Parameters3/5

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

Schema description coverage is 0% and no parameter has an enum, so the description must compensate. It explains three of five: repo (owner/name), milestone (the milestone being shipped), and merged_prs (pull requests in it, owner/repo#12), but leaves commit and project undefined beyond a passing mention in the failure conditions, and never explains why all five are optional with defaults.

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

Purpose4/5

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

Opens with a specific question ('May this commit be shipped?') and names the exact mechanism: the project's guardrails at the pre_release hook. The release-stage framing ('before tagging or deploying') separates it from merge-time checks, though it never names the obvious sibling merge_ready to make the distinction explicit.

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?

Gives concrete when-to-use guidance — 'Call it before tagging or deploying and stop when it is not ready' — which also encodes the control flow (halt on not-ready). It stops short of stating when not to use it or naming the alternative check to run at an earlier stage.

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