Skip to main content
Glama

validate_markdown

Read-onlyIdempotent

Pre-flight markdown validation BEFORE conversion. Catches malformed tables (mismatched pipes), unclosed code fences, broken task lists, and unsupported syntax. Returns a green/amber/red status plus the detected markdown features.

CALL THIS PROACTIVELY when:

  • The user is about to convert a long document (>5 pages) — validating first is cheap; running a doomed conversion costs credits

  • The user reports a previous conversion produced broken output

  • You generated the markdown yourself and want to verify it's clean before spending credits

Returns: status (green=safe, amber=minor issues, red=will likely break), detected features (tables, code blocks, task lists, math), and a human-readable message.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
contentYesMarkdown content to validate
filenameNoOptional filename label for the response (defaults to 'content.md')

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -{
      -  "properties": {
      -    "additionalPandocFlags": {
      -      "description": "Pandoc flags that will be applied",
      -      "items": {
      -        "type": "string"
      -      },
      -      "type": "array"
      -    },
      -    "detectedFeatures": {
      -      "description": "Map of markdown features found in the content",
      -      "type": "object"
      -    },
      -    "filename": {
      -      "description": "Filename label echoed back",
      -      "type": "string"
      -    },
      -    "inputFormat": {
      -      "description": "Detected markdown flavour (e.g. gfm, commonmark)",
      -      "type": [
      -        "string",
      -        "null"
      -      ]
      -    },
      -    "message": {
      -      "description": "Human-readable explanation of any issues",
      -      "type": "string"
      -    },
      -    "status": {
      -      "description": "Validation verdict",
      -      "enum": [
      -        "green",
      -        "amber",
      -        "red"
      -      ],
      -      "type": "string"
      -    }
      -  },
      -  "required": [
      -    "status",
      -    "message"
      -  ],
      -  "type": "object"
      -}New value: +null
  2. First observed

TDQS

A4.3/5.0
Behavior4/5

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

The annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the description need not repeat those. It adds valuable behavioral context: validation is cheap compared to conversion, it returns a green/amber/red status, and it detects specific markdown features. This goes beyond the annotations without contradicting them.

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?

The description is front-loaded with the core purpose and follows with well-structured, scannable sections for usage guidelines and return values. Every sentence provides distinct value—no filler, no repetition of schema fields, and the bulleted triggers are tightly written.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool has no output schema, the description compensates by detailing the return payload (status, detected features, human-readable message). It also covers when to use the tool, what it catches, and why it matters financially, making it fully self-contained for an agent to decide and invoke correctly.

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?

The input schema already has 100% description coverage for both parameters (content and filename), so the baseline is 3. The description does not add any parameter-specific semantics beyond what the schema provides; it focuses on output and usage context instead.

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?

The description opens with 'Pre-flight markdown validation BEFORE conversion', clearly identifying the tool's specific verb, resource, and timing. It lists exact failure modes it detects (malformed tables, unclosed code fences, broken task lists, unsupported syntax) and distinguishes it from conversion tools like convert_document.

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?

It explicitly states when to call the tool proactively, with three concrete scenarios ('user is about to convert a long document', 'user reports broken output', 'you generated the markdown yourself'). It also contrasts validation cost with conversion cost, but it does not explicitly mention when NOT to use it or name an alternative tool.

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.

TDQS

A4.5/5.0
Disambiguation5/5

Each tool has a clearly distinct purpose: credit balance vs cost estimation, template listing scoped to all/built-in/custom, and conversion vs validation. The three list tools are explicitly named by scope, eliminating ambiguity.

Naming Consistency5/5

All tool names follow the same verb_noun snake_case pattern (check_, convert_, estimate_, get_, list_, recommend_, show_, validate_), making the API predictable and easy to navigate.

Tool Count5/5

10 tools is well within the ideal 3-15 range for a document conversion service. Each tool addresses a necessary step in the workflow (template selection, validation, cost estimation, conversion, credit monitoring) without redundancy.

Completeness4/5

The core lifecycle (pre-flight validation, cost estimation, conversion, balance checking, template discovery) is fully covered. Minor gaps exist—no template upload or settings update—but these are likely handled outside the MCP server, so the surface is complete for its intended agent workflows.