Skip to main content
Glama

Export Markdown

export_markdown
Read-onlyIdempotent

Convert a document to Markdown. Policy fallback (default) keeps readable text for blocks Markdown cannot express; archival preserves every block losslessly.

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": {
      "document": "<document>"
    },
    "name": "export_markdown"
  }
}

Input Schema

NameRequiredDescriptionDefault
policyNo
documentYesThe Publisle document: an object with schemaVersion and blocks, as returned by the other tools.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/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 safety profile is covered. The description still adds real behavioral context by explaining what each policy does to blocks that Markdown cannot represent, which is the key trade-off an agent must reason about. It stops short of describing the output shape or any failure modes.

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?

Two sentences, with the purpose front-loaded and the policy semantics following. Nothing is wasted. A slightly clearer separation between the two policies would help, but the structure is sound.

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 only two parameters and full annotation coverage, the definition is close to complete, and the policy explanation fills the main gap in the schema. It still leaves the nested document contract largely to the schema and never describes the return value, which matters because no output schema exists.

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 schema documents the document object and constrains policy to two enum values, but says nothing about what those values mean. The description supplies that meaning for both policies and calls fallback the default, which is genuine added value. However, it says nothing about the shape of the returned Markdown or how nested blocks are flattened.

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: "Convert a document to Markdown." That distinguishes it from siblings like render_html and compile_pdf, which produce other formats. It does not explicitly name those alternatives, but the output format alone is enough to identify the tool.

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 rather than stated: the agent can infer that this is for producing Markdown, but the description never says when to choose this over render_html or compile_pdf. It also doesn't say what input is accepted beyond "a document," so there is no prerequisite guidance.

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