Skip to main content
Glama

Markdown footnote references

bpj_markdown_footnote_crosscheck
Read-onlyIdempotent

Compare single-line footnote definitions with inline markers to find missing or unused notes.

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": {
      "text": "<text>"
    },
    "name": "bpj_markdown_footnote_crosscheck"
  }
}

Input Schema

NameRequiredDescriptionDefault
textYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so safety is covered. The description's valuable addition is the scope constraint 'single-line' definitions, warning that multi-line footnotes are out of scope, but it says nothing about what the comparison result looks like or how duplicates/ambiguity are handled.

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?

One tight sentence with the comparison operands front-loaded and the result clause last; nothing is wasted. It is arguably too terse for the gaps it leaves, but there is no redundant or filler text.

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?

No output schema exists, so the description should sketch what the crosscheck returns (e.g., lists of undefined markers and unused definitions) but does not. For a simple single-input, read-only checker this is a noticeable but not fatal omission.

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?

The single 'text' parameter has only a title and a 6000-character maxLength in the schema, with 0% description coverage; the description never explains that this is the Markdown document to be scanned, nor what happens if the input is truncated at the limit. With one parameter at near-zero schema coverage, the description should carry that burden and does not.

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?

Specific verb ('Compare') plus both operands ('single-line footnote definitions' vs 'inline markers') and the outcome ('missing or unused notes'). It is clearly distinct from reference-index/coverage siblings, which deal with link references rather than footnotes, though the description never states that distinction explicitly.

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?

Use case is implied by the stated output (finding broken or orphaned footnotes), but there is no explicit when-to-use, no prerequisites, and no mention of alternatives such as the reference-coverage siblings. An agent can infer intent but gets no routing help.

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.