Skip to main content
Glama

audit_release

Inspect a local repo for release readiness: verify starter match, detect CHANGELOG drift vs merged PRs, check version-bump status and publish workflow. Read-only; never changes files.

Instructions

Audit a local repo for release-readiness against the Starter Series quality bar. Detects matched starter, CHANGELOG drift vs merged PRs, version-bump status, and publish-workflow presence. Read-only; never mutates the repo.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathNoPath to the repo to audit (default: the MCP server's cwd). Use the absolute path of the project the user is working in.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
versionYes
repoPathYes
changelogYes
shipReadyYes
matchedStarterYes
publishWorkflowYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changedv0.5.3
    • removedOutput schema / properties / changelog / properties / file / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / changelog / properties / file / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / matchedStarter / properties / id / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / matchedStarter / properties / id / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / version / properties / current / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / version / properties / current / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / version / properties / lastTag / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / version / properties / lastTag / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  2. First observedv0.4.0

TDQS

A4/5.0
Behavior4/5

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

With no annotations provided, the description carries the full behavioral burden and does state the safety profile explicitly: 'Read-only; never mutates the repo.' It also enumerates the detection categories. It does not cover prerequisites (e.g., repo must be a git checkout with a remote), permissions, or failure modes.

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?

Three tightly packed sentences: purpose first, then the specific checks, then the safety guarantee. No filler and every clause carries information.

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?

An output schema exists, so return values needn't be described, and read-only behavior is covered. The remaining gap is minor: no mention of prerequisites or environment assumptions for the audit to succeed.

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 100% and the single path parameter is fully documented in the schema, including the cwd default and the advice to use absolute paths. The description adds only that the target is 'local', so baseline 3 applies.

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?

States a specific verb (audit) and resource (local repo) plus the exact scope: release-readiness against the Starter Series quality bar. The enumerated checks (matched starter, CHANGELOG drift vs merged PRs, version-bump status, publish-workflow presence) make it easy to distinguish from siblings like audit_security, audit_cd, and audit_instructions.

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 phrase 'release-readiness' implies the usage context (pre-release gating), but there is no explicit when-to-use or when-not-to-use guidance, and no routing to sibling audit_* tools. Usage is inferable rather than stated.

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