Skip to main content
Glama

record_milestone_check

Records a milestone acceptance check result and optional note, letting teams track pass/fail outcomes for crew checks after merges.

Instructions

Record one run of a milestone's acceptance check (TR-1017): milestone its name or id, n the check's number (1-based, as list_milestones shows), result pass or fail, note the last lines of what it showed. Run a milestone's crew checks (for crew) as soon as its last ticket merges and record every one; a fail is the crew's work (open a ticket for it). Checks for person are the person's: they try them in the console, never record those.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "milestone": "<milestone>",
      "n": "<n>",
      "result": "<result>"
    },
    "name": "record_milestone_check"
  }
}

Input Schema

NameRequiredDescriptionDefault
nYes
noteNo
resultYes
projectNo
milestoneYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.57.0

TDQS

A4.5/5.0
Behavior4/5

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

With no annotations, the description carries the load and does disclose meaningful behavior: what `note` should contain (last lines of output), that results are pass/fail, and that a fail is the crew's work requiring a ticket. It does not state whether recording the same check twice appends a second run or replaces the prior one, nor any permission requirement, which is a real gap for a mutation.

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 action, then parameter meanings, then workflow rules. Dense but nearly every clause carries information. The backticked-parameter shorthand (e.g. "`for` crew") reads slightly compressed and costs a moment of parsing.

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 need not be explained, and the description covers the operational rules an agent needs before writing. Missing pieces are the undocumented `project` parameter and repeat-recording/idempotency semantics for a no-annotation mutation tool.

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 description coverage is 0%, so the description must compensate, and it does for four of five parameters: `milestone` (name or id), `n` (1-based, matching list_milestones output), `result` (pass or fail, an enum the schema lacks), and `note` (last lines of output). The `project` parameter is never mentioned, leaving one field undefined.

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 opens with a specific verb and resource: "Record one run of a milestone's acceptance check (TR-1017)". It distinguishes this from sibling tools by pointing at list_milestones as the source of the check number, so an agent can place the tool precisely in the workflow.

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

Usage Guidelines5/5

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

It gives explicit timing (run crew checks as soon as the milestone's last ticket merges) and an explicit exclusion (checks `for` person are the person's, they try them in the console, never record those). It also routes failure handling elsewhere: open a ticket for a fail.

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