Skip to main content
Glama
MCP Agent Operations

MCP Agent Operations

verify_markdown_links

Read-onlyIdempotent

Validates local links in selected Markdown files to catch broken references. Choose exact paths, globs, git-changed files, or changes since a checkpoint for targeted link checks.

Instructions

Verify local Markdown links using explicit or server-derived file selection.

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": {
      "repository_root": "<repository_root>"
    },
    "name": "verify_markdown_links"
  }
}

Input Schema

NameRequiredDescriptionDefault
scopeNo``patterns``, ``git_changed``, or ``changed_since_checkpoint``.patterns
patternsNoExact paths or globs used only with ``scope=patterns``. Omission checks every Markdown file in that scope for backward compatibility.
checkpoint_idNoRequired only for ``changed_since_checkpoint``.
repository_rootYesAbsolute Git worktree or pattern root beneath a workspace root.

Output Schema

NameRequiredDescriptionDefault
okYes
scopeNopatterns
findingsNo
added_filesNo
checked_filesNo
checkpoint_idNo
deleted_filesNo
renamed_filesNo
modified_filesNo
selected_filesNo
unmatched_patternsNo
affected_inbound_filesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed13 schema fields changedv0.15.1
    • addedInput schema / properties / checkpoint_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null,
      +  "description": "Required only for ``changed_since_checkpoint``."
      +}
    • addedInput schema / properties / patterns / description
      Added value: +"Exact paths or globs used only with ``scope=patterns``. Omission checks\nevery Markdown file in that scope for backward compatibility."
    • addedInput schema / properties / repository_root / description
      Added value: +"Absolute Git worktree or pattern root beneath a workspace root."
    • addedInput schema / properties / scope
      Added value: +{
      +  "default": "patterns",
      +  "description": "``patterns``, ``git_changed``, or ``changed_since_checkpoint``.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / added_files
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / affected_inbound_files
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / checkpoint_id
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "default": null
      +}
    • addedOutput schema / properties / deleted_files
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / modified_files
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / renamed_files
      Added value: +{
      +  "items": {
      +    "additionalProperties": {
      +      "type": "string"
      +    },
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / scope
      Added value: +{
      +  "default": "patterns",
      +  "type": "string"
      +}
    • addedOutput schema / properties / selected_files
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / unmatched_patterns
      Added value: +{
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
  2. First observedv0.5.1

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, non-destructive and non-open-world, so the safety profile is fully covered without the description. The description contributes the useful behavioral detail that only local links are checked (not external URLs), but says nothing about what happens on failure, whether the call errors or just reports, or how checkpoint state is used.

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 no redundant wording and no filler. It is efficient, though the terseness borders on under-specification given the tool's four-parameter scope machinery.

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?

With annotations, a full-coverage input schema and an output schema all present, the structured data carries most of the burden, so the description only needs to supply intent and usage framing. It manages the intent but omits when-to-use guidance and any note on failure behavior for what is fundamentally a diagnostic tool.

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 the four parameters including the scope enum values and checkpoint_id requirement are already fully documented in the schema. The description's "explicit or server-derived file selection" only loosely gestures at that same distinction and adds no format or constraint detail beyond it. Baseline 3 applies.

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 and resource ("Verify local Markdown links"), which distinguishes it clearly from a sibling like verify_yaml and tells the agent what is being operated on. The qualifier "local" usefully narrows the scope, though what "verify" actually does (broken-link detection) is left implicit.

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

Usage Guidelines2/5

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

There is no explicit guidance on when to use this tool versus alternatives such as verify_yaml, nor when to prefer one scope mode over another. The phrase "explicit or server-derived file selection" hints at the scope/patterns/checkpoint mechanism but never states the conditions that select each.

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