Skip to main content
Glama

check

Validate a domain read-only for broken links/anchors, index gaps, duplicate paragraphs, malformed decision records, and stale sources; the same validation rolls back writes that add problems.

Instructions

Read-only check of a domain: broken links and anchors, notes missing from the index, an index without its summary (the domain description), the same paragraph claimed in two notes, decision records without exactly one Status line, stale live sources. The same check runs inside every write and rolls the write back if it adds a problem.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "domain": "<domain>"
    },
    "name": "check"
  }
}

Input Schema

NameRequiredDescriptionDefault
domainYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

B3.4/5.0
Behavior4/5

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

With no annotations, the description does real work: it declares the operation read-only, lists exactly what is validated, and discloses the important non-obvious coupling that writes execute this check and abort on new problems. What it does not disclose is how results are surfaced (report vs. error) or whether severity/ordering matters.

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 dense sentences that lead with the operation and its read-only nature, then the rollback coupling. The long enumeration is information-bearing rather than padding, though it could be split for readability.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple single-parameter, read-only tool this covers intent and scope well, but with no output schema the description should explain what a check returns (list of problems? a pass/fail?) and how problem categories are reported. That missing piece leaves an agent unable to interpret the result.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0% for the single 'domain' parameter, and the description never clarifies what a domain identifier looks like (name, slug, path). The repeated use of 'domain' implies it is a container with an index and summary, but gives no usable detail for supplying the value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb ('Read-only check') and resource ('a domain') and then enumerates the concrete problems it detects (broken links/anchors, missing index notes, missing domain summary, duplicate paragraph claims, decision records without exactly one Status line, stale live sources). No other sibling (move, brief, search, read, links, patch_*) performs validation, so it is distinguishable, though it never explicitly says so.

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

Usage Guidelines3/5

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

It implies usage by noting the same check runs inside every write and rolls the write back, which hints that calling it directly is a pre-flight/diagnostic action rather than a mandatory step. It gives no explicit when-to-use or when-not-to-use statement and names no alternative tool.

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