Skip to main content
Glama

agent-readiness

Explain one check

explain_check
Read-only

Explain one check from the Agent Readiness Score: what it asks, why an agent cares, how it is weighted, and how to fix it. Use after score_site when the user asks why a particular finding matters.

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. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.1/5.0
Behavior3/5

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

The readOnlyHint annotation already indicates this is a safe read operation, and the description does not contradict it. The description adds what the explanation covers, but it does not disclose additional behavioral traits such as data freshness, dependencies on prior calls, or potential error conditions. The annotation does the heavy lifting here.

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?

Two sentences with no wasted words. The first sentence fully defines the tool's scope and output content; the second gives a precise invocation trigger. The description is front-loaded and easy to scan.

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?

For a one-parameter, read-only tool with an output schema, the description covers the essential context: what the tool does, what content it returns, and when to call it. Nothing important is missing for an agent to select and invoke it correctly.

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?

The input schema already documents checkId with an example, so coverage is 100%. The description adds only the context that the check belongs to the Agent Readiness Score, which is marginal extra meaning. Baseline 3 is appropriate because the schema already fully describes the parameter.

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 names a specific verb ('Explain'), a specific resource ('one check from the Agent Readiness Score'), and enumerates exactly what the explanation includes: what it asks, why agents care, weighting, and remediation. This clearly distinguishes it from sibling tools like list_checks, which enumerate checks, and score_site, which produces the score.

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 explicitly says to use this tool 'after score_site when the user asks why a particular finding matters.' This gives a clear trigger condition and temporal context. It does not explicitly name alternatives to avoid, so it stops short of a 5, but the usage context is strong.

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.

TDQS

A4.4/5.0
Disambiguation5/5

Each tool targets a clear, distinct action: scoring a site, listing checks, explaining a single check, fetching badge HTML, and setting up monitoring. The descriptions include explicit usage guidance that removes any ambiguity.

Naming Consistency5/5

All tool names follow a consistent verb_noun snake_case pattern: explain_check, get_badge_embed, list_checks, score_site, watch_site. The naming is uniform and predictable.

Tool Count5/5

Five tools is well-scoped for a focused agent-readiness scoring service. Each tool contributes a distinct part of the workflow without redundancy or bloat.

Completeness4/5

The surface covers the core workflow: score, understand checks, explain findings, get a badge, and monitor a site. A minor gap is lack of a way to cancel or remove an active watch.

Resources