Skip to main content
Glama

markdown_to_docx

Idempotent

Convert Markdown files to DOCX with headings, lists, tables, links, and code blocks, then return a fidelity report separating passed, failed, and unchecked content.

Instructions

DOCX from Markdown (CommonMark + pipe tables + strikethrough) via sandboxed Pandoc: headings, paragraphs, bold/italic, lists, tables, links, code blocks. Images are never fetched (alt text is kept). The report checks text, numbers, identifiers and structure. [docbridge schema 0.2.4]

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
detailNosummary: report_summary + report_id (get_report has the rest). full: the whole report inline.summary
encodingNoText encoding of a .md/.txt input. Omit for UTF-8; docbridge never guesses.
overwriteNo
input_pathYesAbsolute file path.
output_pathNo
report_pathNo
max_differencesNoDifferences kept in the full report; the rest are counted.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
toolYes
errorNo
reportNoThe full report. Over MCP only with detail='full'.
outputsNo
report_idNoPass to get_report for the full report (held for this server session).
disclaimerNodocbridge never alters, summarizes or silently truncates source evidence. docbridge reports what it compared. PASS on an axis covers only that axis's stated scope; NOT_CHECKED and UNSUPPORTED are never passes. PDF text is the text layer as PyMuPDF decodes it, not the rendered glyphs. Nothing here interprets meaning: numbers are compared as characters, not as values.
report_pathNo
report_summaryNo
schema_versionYes
conversion_notesNo
operation_completedYesThe operation ran and wrote its outputs. Says NOTHING about fidelity: read the report status.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.4

TDQS

A3.6/5.0
Behavior4/5

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

Annotations declare the safety profile (readOnlyHint=false, idempotentHint=true, destructiveHint=false), and the description adds genuinely useful context beyond them: processing is sandboxed Pandoc, images are never fetched and alt text is preserved, and a structural report is produced. These are behavioral facts not derivable from the schema.

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?

Front-loads the core purpose and packs supported-feature detail efficiently. The clauses are dense and slightly run-on ('sandboxed Pandoc: ... links, code blocks'), but every sentence carries information relevant to invoking the tool.

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?

An output schema exists, so return-value explanation is not required, and the description covers conversion semantics and image handling. It nonetheless omits how output_path/report_path/overwrite behave (destination and file-clobbering behavior) for a tool whose default overwrite is false, leaving a gap for an agent deciding where output lands.

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 57%, with detail, encoding, and max_differences well documented in the schema itself. The description adds only an oblique reference ('The report checks...') and says nothing about output_path, report_path, or overwrite, so it does not compensate for the uncovered parameters. Baseline 3 fits.

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?

States a specific verb+resource (produce DOCX from Markdown) and enumerates supported constructs (CommonMark, pipe tables, strikethrough, headings, lists, tables, code blocks). It clearly identifies the conversion direction, though it never names the sibling markdown-family tools to differentiate itself.

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?

Usage is implied by the name and description (you have Markdown, you want DOCX), and the sandboxed-Pandoc note hints at the processing context. However, there is no explicit when-to-use/when-not guidance and no mention of the adjacent converters (txt_to_docx, docx_to_markdown, validate_conversion).

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