Skip to main content
Glama

checklist

Register the machine-checkable acceptance criteria extracted from a design brief; each export then verifies the deliverable against them and reports unmet items.

Instructions

Register the brief's ACCEPTANCE CHECKLIST for a design — the machine-checkable claims that must hold before the work counts as done. Do this right after intake, before the first edit: extract from the brief every required output file, every string of approved copy that must land verbatim, and note the constraints only you can check.

Item kinds:

  • { kind: 'output', path } — a file that must exist when the design is delivered (absolute path, e.g. every variant the brief orders exported).

  • { kind: 'copy', text } — approved copy that must appear VERBATIM in the design's text (whitespace variants are folded before comparing; wording, case and punctuation are exact).

  • { kind: 'note', text } — a self-check the server cannot verify (e.g. "layout structure unchanged from master"). Kept on record; never machine-checked.

Every export verifies the current checklist against the deliverable and lists unmet items in its result — treat an unmet item exactly like a failing test: finish the work, or re-register the checklist without the item if it is genuinely obsolete. Calling checklist again REPLACES the whole list for this design.

Returns: { ok, itemCount, rootRevision } — or the current checklist when called with only revision (no items).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
itemsNoThe full checklist (max 64 items) — replaces any previously registered list. Omit to read the current checklist instead.
revisionYesAny revision id of the design (the checklist attaches to the design's whole lineage).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A5/5.0
Behavior5/5

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

With no annotations, the description carries the full burden and delivers richly: it discloses that calling again REPLACES the whole list, that copy comparisons fold whitespace but treat wording/case/punctuation as exact, that note items are never machine-checked, that every export verifies the checklist, and the exact return shape. No behavioral surprise is left undisclosed.

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 long but every sentence earns its place. The lead sentence front-loads the core purpose; the item-kind bullets are necessary because the schema cannot convey these semantics; and the export-interaction and replacement warnings are essential operational facts. No filler or repetition.

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

Completeness5/5

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

Given no output schema and no annotations, the description is fully self-sufficient: it covers return values, item-kind semantics, replacement behavior, lifecycle timing, and failure-handling. An agent can invoke this tool correctly on the first attempt with zero information beyond the description.

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

Parameters5/5

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

Although schema coverage is 100%, the description dramatically expands meaning beyond the bare field names: it defines each kind's semantics (output = absolute path that must exist; copy = verbatim with whitespace folding; note = never machine-checked), explains the read mode when only revision is passed, and documents the return object. This far exceeds the baseline-3 bar.

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 states a specific verb+resource: 'Register the brief's ACCEPTANCE CHECKLIST for a design — the machine-checkable claims that must hold before the work counts as done.' It is immediately distinguishable from siblings like export (which verifies the checklist), scorecard (which presumably grades), and edit/preview (which mutate/view the design).

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 ('Do this right after intake, before the first edit'), specifies what to extract from the brief (output files, verbatim copy, self-check notes), and explains how unmet items interact with export ('treat an unmet item exactly like a failing test: finish the work, or re-register the checklist without the item'). This is actionable when-to-use guidance that also routes the agent's behavior downstream.

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