Skip to main content
Glama

check_docs

Verify file paths, ports, systemd units, and Forgejo repos in markdown docs against the live system, returning drifted claims with file:line and reasons so you can fix outdated documentation.

Instructions

Check factual claims (file paths, local ports, systemd units, Forgejo repos) in markdown docs or directories of docs against the live system. Returns drifted claims with file:line and why. Set include_ok=true to also list claims that verified fine. Claims tagged <!-- driftcheck: scope=X --> are only checked when scope=X is passed.

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": {
      "paths": "<paths>"
    },
    "name": "check_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathsYes
scopeNo
include_okNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses the return shape (drifted claims with file:line and why), the include_ok toggle's effect, and the opt-in scoping mechanism via `<!-- driftcheck: scope=X -->` tags. It does not state whether verification has side effects or how errors (unreadable files, unreachable host) are reported.

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?

Three sentences, front-loaded with what is checked and where, then return format, then the opt-in modifiers. No filler, and the non-obvious scope syntax is stated literally.

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?

No output schema exists, and the description compensates by describing the return value; no annotations exist, and the read-only nature is strongly implied by 'check ... against the live system'. A tool with three loosely-typed parameters is adequately specified, though error and empty-result behavior remain unstated.

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 0%, yet all three parameters receive meaning in prose: paths accepts either markdown files or directories of docs, include_ok widens output, and scope gates tagged claims. The only ambiguity is the default behavior of scope when omitted (presumably untagged claims are always checked).

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 ('check factual claims ... against the live system') and enumerates the claim classes it understands (file paths, local ports, systemd units, Forgejo repos), which makes the tool's scope unambiguous even with no siblings to compare against.

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?

Usage is clear from the semantics: run it against markdown docs or directories to detect drift from the live system, with per-parameter guidance on include_ok and scope. It stops short of explicit when-not-to-use guidance or stating preconditions (e.g. host access needed to verify ports/units).

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

Deploy Server

Other Tools