Skip to main content
Glama

Cross-check snippets

cross_check_snippets

Extracts fenced code blocks from documentation and checks referenced files, imports, exports, call arity, and npm scripts against a local or GitHub repo to surface broken snippets.

Instructions

Extract fenced code blocks from docs and verify referenced files, imports, exports, call arity, and npm scripts against the repo.

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": "cross_check_snippets"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathNoAbsolute or relative local path to a git checkout
githubNoGitHub repo as owner/repo or https://github.com/owner/repo (public repos via GitHub API)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

B3.2/5.0
Behavior2/5

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

With no annotations, the description carries the full behavioral burden yet never states that the tool is read-only, what the result looks like (no output schema exists), whether GitHub API rate limits apply, or that at least one of path/github must be supplied since both are optional. It does disclose the concrete verification surface, which is the one strong behavioral signal, but critical operational traits are absent.

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?

A single front-loaded sentence with the action verb first and no filler. The long enumeration of checks is dense but each item earns its place; a short clause separating extraction from verification would slightly improve scanability.

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?

The description covers the verification scope well enough for a two-parameter read operation, but with no output schema and no annotations it should say what a caller gets back (a mismatch report?) and clarify the path/github either-or requirement. Those are real gaps for an agent deciding whether and how to invoke it.

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 description coverage is 100%, so both parameters are already documented in the schema, making 3 the baseline. The description only gestures at a repo source ('against the repo') and adds no meaning about choosing local path versus GitHub, nor about the implicit at-least-one-required relationship between them.

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 two concrete verbs (extract, verify) and enumerates exactly what is checked — referenced files, imports, exports, call arity, npm scripts — so the agent knows this consolidates documentation snippets against a repo. It does not, however, distinguish itself from siblings such as run_full_audit or analyze_open_issues, which plausibly overlap in scope.

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?

The scenario (docs containing fenced code blocks that reference a repo) implies when the tool applies, but there is no explicit when-to-use or when-not guidance and no named alternative. Nothing tells the agent whether to reach for this instead of read_docs or run_full_audit, leaving routing to inference.

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