Skip to main content
Glama

validate_markdown

Validate a markdown document for PDF/UA-1 accessibility issues (heading hierarchy, missing alt text). Cheap — no rendering. Mirrors POST /api/v1/md/validate.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
markdownYesGitHub-flavored markdown source. Max 200KB of text; inline data: image payloads are excluded from that budget.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / markdown / description
      Previous value: -"GitHub-flavored markdown source."New value: +"GitHub-flavored markdown source. Max 200KB of text; inline data: image payloads are excluded from that budget."
    • removedInput schema / properties / markdown / maxLength
      Removed value: -200000
  2. First observed

TDQS

A3.9/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full burden. It usefully discloses that no rendering occurs (implying a lightweight, likely read-only pass), but says nothing about required permissions, whether validation is exhaustive, or what the result shape is. Partial disclosure only.

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?

Two short sentences, front-loaded with the purpose before the cost/endpoint note. No filler and nothing repeated from the schema.

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-input validation tool this covers the essentials, but with no output schema and no annotations nothing tells the agent what comes back (a boolean, a list of issues, severity levels) or whether the call is side-effect free. A sentence on the result would close the remaining gap.

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?

Only one parameter, and the schema already documents it fully (GitHub-flavored source, 200KB budget, inline data: images excluded) at 100% coverage. The description adds no syntax or format detail beyond the schema, so the baseline of 3 applies.

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?

Specific verb (Validate) plus resource (markdown document) plus the standard targeted (PDF/UA-1) and the concrete issue classes checked (heading hierarchy, missing alt text). It is clearly distinct from siblings like render_markdown and validate_dsl.

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?

"Cheap — no rendering" signals the context in which this tool is preferred over a render-then-inspect approach, and the API mirror gives an integration cue. It stops short of explicitly naming render_markdown or stating when-not to use it, so it is clear context without exclusions.

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.

Resources