Skip to main content
Glama

render_markdown

Render GitHub-flavored markdown to a real PDF (PDF/A-2A + PDF/UA-1 dual-compliant, tagged). BILLED - consumes credits at the rate of 1 credit per 10 pages. Returns JSON metadata (pageCount, creditsDeducted, creditsRemaining, artifactId) plus the PDF bytes as an embedded base64 resource. On the free plan the PDF is watermarked; paid plans render clean. Mirrors POST /api/v1/md. Run validate_markdown first - it is free and catches heading-hierarchy and alt-text problems before you pay to render them. There is no free markdown preview: markdown needs no layout iteration, so this is the only markdown render tool.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
optionsNoOptional render settings. Anything omitted falls back to YAML frontmatter in the markdown, then to the runtime default.
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
    • addedInput schema / properties / options / properties / pageNumberPosition
      Added value: +{
      +  "description": "Footer alignment when pageNumbers is set. Default 'right'. Ignored without pageNumbers.",
      +  "enum": [
      +    "left",
      +    "center",
      +    "right"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / options / properties / pageNumbers
      Added value: +{
      +  "description": "Footer page-number format: 'page-n-of-total' (Page 3 of 12), 'n-of-total' (3 / 12), or 'n' (3). Omit for no page numbers.",
      +  "enum": [
      +    "page-n-of-total",
      +    "n-of-total",
      +    "n"
      +  ],
      +  "type": "string"
      +}
  2. 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
  3. Added

TDQS

A4.7/5.0
Behavior5/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 and does so: it discloses the billing model (1 credit per 10 pages), plan-dependent watermarking, output composition (JSON metadata plus base64 PDF resource), and the API endpoint it mirrors. This is well beyond what the schema conveys.

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?

Five tight sentences with no filler; each carries a distinct fact (compliance, cost, return shape, plan behavior, prerequisite). The billing warning is set off typographically so the cost signal is not buried.

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?

For a nested-schema tool with no output schema and no annotations, the description supplies everything an agent needs: cost, prerequisite, plan-dependent output, and an explicit account of the return payload. Nothing material is left to inference.

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 already 100%, including the fallback chain ('Anything omitted falls back to YAML frontmatter..., then to the runtime default'), so the schema does the heavy lifting. The description adds no per-parameter meaning for `options` fields such as theme, splitMode, or margins, so the baseline 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?

States a specific verb and resource ('Render GitHub-flavored markdown to a real PDF') plus differentiating qualities (PDF/A-2A + PDF/UA-1, tagged). It explicitly distinguishes itself from the sibling preview/render tools by noting this is the only markdown render tool and that no free markdown preview exists.

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

Usage Guidelines5/5

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

Gives explicit when-to-use sequencing: 'Run `validate_markdown` first - it is free and catches heading-hierarchy and alt-text problems before you pay to render them.' It also rules out an alternative an agent might otherwise hunt for ('There is no free markdown preview'), which is exactly the routing guidance needed.

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