Skip to main content
Glama

Correct a check

update_check
Destructive

Correct a check — its wording, or which platforms it applies to. Use when a step is wrong or misleading, or when a check does not belong on a platform at all. Pass not_applicable_on to mark it N/A there; it then stops counting towards coverage on those platforms. The reference is not editable; it is a position in the section's series.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
appYesApp name.
expNoNew expected result.
preNoNew preconditions.
refYesCheck reference.
stepsNoNew steps.
titleNoNew title.
not_applicable_onNoPlatform codes this check does not apply to, e.g. ['IOS','AND'] for a web-only check. Replaces the current list rather than adding to it — pass [] to make the check apply everywhere again. Omit to leave it alone.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already signal mutation (readOnlyHint=false, destructiveHint=true), and the description adds useful behavioral detail: not_applicable_on marks a check N/A and stops it counting toward coverage, and the reference is not editable. No contradiction with annotations.

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?

Four dense sentences, front-loaded with purpose, then usage, then key behavioral constraints. No filler or redundant restatement of schema fields.

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?

Given seven parameters, full schema descriptions, and a destructive annotation, the description supplies the missing usage context and key side effects. No output schema exists, but for an update operation the returned value is not critical to invoking it correctly.

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 coverage is 100%, so the baseline is 3. The description adds value beyond the schema by explaining the effect of not_applicable_on on coverage and by stating that ref is a position rather than an editable value.

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 ('Correct') on a specific resource ('a check') and clarifies the scope: wording or platform applicability. This lets an agent distinguish it from siblings like add_check, get_check, and list_checks without opening the schema.

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?

It gives explicit trigger conditions: use when a step is wrong or misleading, or when a check does not belong on a platform. It does not explicitly name alternatives or exclusions, but the intended scenarios are clear.

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.