Skip to main content
Glama

Explain a finding

explain_finding
Read-onlyIdempotent

Why CrawlCheck decided a finding: the rule and its revision, the exact fetches it compared (identity, status, bytes, sha256), when the condition held on the site, and a Merkle proof that the decision is inside the signed manifest. Give id (a d1: decision or f1: finding id from a report), or domain alone for its top finding, or domain plus code for a named finding. Free, no key; read-only. A finding's age and history need a licence for that domain (send it in x-crawlcheck-key).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "explain_finding"
  }
}

Input Schema

NameRequiredDescriptionDefault
idNod1: decision id, f1: finding id, or report id
codeNoFinding code, e.g. STALE_CACHE_SERVED (with domain)
pathNo
domainNoBare domain; alone it explains the top finding

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / code / description
      Previous value: -"Finding code (licence only)"New value: +"Finding code, e.g. STALE_CACHE_SERVED (with domain)"
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already cover safety (read-only, idempotent, non-destructive), but the description adds real context beyond them: it is free with no key, and age/history data requires a per-domain licence passed in x-crawlcheck-key. It also discloses the shape of the evidence returned, though it says nothing about failure behavior for unknown ids.

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?

Front-loads what the tool explains, then parameter forms, then cost/auth, in a logical progression with no filler sentences. It is dense—one long block rather than separated sentences—but every clause carries information.

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?

With no output schema, the description correctly compensates by describing the evidence payload, and it covers the licensing constraint that gates part of the response. Only the role of 'path' and the behavior on invalid or unknown ids are left unaddressed.

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?

Adds significant meaning over the schema: it explains the d1:/f1: id prefixes, that a bare domain resolves to the top finding, and that domain plus code selects a named finding, clarifying how the parameters interact. The 'path' parameter is left unexplained in both the schema and the description, which holds it back from a 5.

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?

Names a specific verb and resource ('why CrawlCheck decided a finding') and enumerates the returned evidence (rule + revision, compared fetches, condition timing, Merkle proof). This clearly separates it from the fix_* siblings, which change things rather than explain them.

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?

Gives three concrete input modes: id alone, domain alone for the top finding, or domain plus code for a named finding, which is exactly the 'when to use which form' guidance an agent needs. It stops short of naming a sibling alternative or stating what to do if the id came from a different report.

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.