Skip to main content
Glama

Explain one check

explain_check
Read-onlyIdempotent

Use this when the user asks what a specific Agent Readiness finding means, why it matters to AI agents or how to fix it, usually after score_site. Explains one check: what it asks, why an agent cares, how it is weighted and how to fix it, with a code snippet where one exists. Answers from the rule set only and fetches nothing.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
checkIdYesCheck identifier, for example content-without-javascript

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
fixYes
whyYes
docsNo
titleYes
pillarNo
pointsYes
snippetNo
questionYes
conditionalYes

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?

The annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description adds genuinely useful behavioral context beyond them: 'Answers from the rule set only and fetches nothing', which tells the agent the answer is static and deterministic rather than live data. It does not cover failure modes such as an unknown checkId, which keeps it from a 5.

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?

Two sentences with the trigger condition front-loaded and the return contents enumerated compactly. The only slack is the parenthetical-style clause 'usually after score_site', which is useful but slightly lengthens the opener.

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?

An output schema exists, so return values need no explanation in prose. Between description and schema the agent knows when to call it, what to pass, what it returns, and that the answer is rule-set-derived rather than fetched. Nothing material is missing.

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 100% and the single checkId parameter already carries a concrete example ('content-without-javascript'). The description adds no further syntax, format, or lookup hints beyond what the schema provides, so the baseline 3 applies.

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 ('Explains one check') and enumerates the exact content returned: what it asks, why an agent cares, weighting, and fix guidance. It is clearly distinct from list_checks (many checks) and score_site (a full run), so an agent can route 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 Guidelines5/5

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

Gives explicit triggering conditions ('when the user asks what a specific Agent Readiness finding means, why it matters... or how to fix it') and even names the preceding sibling call ('usually after score_site'). This is when-to-use guidance with sibling context, not just implied usage.

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.

Resources