Skip to main content
Glama

onboarding-checklist-inspection-runs

Add a step to a checklist

checklist_item_add

Add one step to a checklist and return its I01-style id: the text, an optional section heading, and whether it is required. A required step that is unanswered or failed blocks sign-off; an optional one does not.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
noteNoGuidance printed under the step, e.g. the tolerance or the standard it is checked against
textYesThe step, as the person doing it will read it, e.g. Tyre pressures checked and recorded
sectionNoA heading to group this step under, e.g. Exterior. Steps keep the order they were added within a section
positionNoInsert at this 1-based position instead of at the end. Existing steps keep their ids
requiredNoWhether sign-off is blocked while this step is unanswered or failed. Default true
checklistYesThe checklist id, e.g. CL-0001, or its name when only one carries it

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already indicate this is a non-read-only, non-idempotent mutation. The description adds valuable behavioral context by explaining that a required step blocks sign-off while an optional one does not, and by noting the returned id. It does not mention duplicate creation on repeated calls, but the idempotentHint=false annotation already covers non-idempotency.

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 two sentences with no wasted words. It front-loads the primary action and return value, then adds the key business rule about required steps. It is easy to scan and fully relevant.

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?

The description covers the core return value and the most important behavioral consequence (sign-off blocking). It does not describe the exact output shape or error conditions, but the schema covers parameter details and the annotations cover mutation/idempotency, making this reasonably complete for an add-item tool.

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%, so the schema fully documents all six parameters. The description only loosely references text, section heading, and required status without adding meaning beyond the schema, so the baseline 3 is appropriate.

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 action ('Add one step to a checklist') and names the concrete resource and return value (an I01-style id). It is clearly distinct from siblings like checklist_item_remove and checklist_create.

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

Usage Guidelines2/5

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

The description says what the tool does but does not provide when-to-use guidance, exclusions, or alternatives. It never mentions that removing a step should use checklist_item_remove or that checklist_create is for creating a new checklist.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.