Skip to main content
Glama

add_check

Records a check you ran on a ticket—command, result, commit, and any broken-then-restored test—logging one line into the ticket's working doc so reviewers can match it to your session.

Instructions

Record a check you ran on a ticket: the exact command, what it showed (result), the commit it ran on, and, for a test you added, broke_test: the test you saw fail when you broke the code it covers (then pass again once restored). One line goes into the Checks part of the ticket's working doc; the rest of the doc is untouched. Record each check after you run it, never one you did not run: the reviewer compares them with your session. Several checks you ran back to back go in one call: more takes the others as [{command, result, commit, broke_test}, ...].

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": {
      "ticket": "<ticket>",
      "command": "<command>",
      "result": "<result>"
    },
    "name": "add_check"
  }
}

Input Schema

NameRequiredDescriptionDefault
moreNo
commitNo
resultYes
ticketYes
commandYes
projectNo
broke_testNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.57.0

TDQS

A4/5.0
Behavior4/5

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

With no annotations, the description carries the behavioral load and does so well: it discloses the write is scoped to one line in the Checks section with the rest of the doc untouched, and warns that the reviewer compares records against the session, implying an audit constraint. It does not cover permissions, duplicate-check handling, or idempotency.

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?

Purpose is stated first, then field semantics, then the batching rule — sensibly ordered. Nearly every clause adds information, though the closing restatement of the `more` element schema partially duplicates the field list already given.

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?

Output schema exists, so return values need not be described. But for a mutation tool with zero annotation coverage and 0% schema descriptions on 7 parameters, the undefined ticket/project relationship and absent permission or duplicate-behavior details leave real gaps.

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 coverage is 0% across 7 parameters, so the description must compensate. It does well for command, result, commit, and broke_test (including the specific fail-then-pass-after-restore definition) and explains `more` as a batch of {command,result,commit,broke_test}. However `ticket` and `project` are never explained, including how the `project` default relates to the ticket.

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 and resource: record a check on a ticket, and enumerates exactly what is captured (command, result, commit, broke_test). The write footprint clause ('One line goes into the Checks part of the ticket's working doc; the rest of the doc is untouched') makes the tool's effect unambiguous and separable from a generic doc editor like attach_working_doc.

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?

Explicit when-to-use rules: 'Record each check after you run it, never one you did not run,' plus a batching rule that several back-to-back checks belong in one call via `more`. It does not name an alternative tool or state when to prefer a sibling, so it falls 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.