Skip to main content
Glama

doer_render_markdown

Render Markdown text into sanitized GitHub-flavored HTML using Doer's Redcarpet pipeline.

Instructions

Render Markdown text to sanitized HTML using Doer's GitHub-flavored markdown Redcarpet pipeline

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": {
      "text": "<text>"
    },
    "name": "doer_render_markdown"
  }
}

Input Schema

NameRequiredDescriptionDefault
textYesMarkdown text to render into sanitized GitHub Flavored HTML

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations at all, the description carries the full burden, and it does disclose one meaningful behavioral trait: output is *sanitized* HTML produced by a specific GFM/Redcarpet pipeline. It does not say what sanitization strips (raw inline HTML, scripts, unsafe attributes), whether the operation is side-effect free, or what the returned value looks like, which are the details an agent most needs for a render tool.

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?

A single front-loaded sentence with the action, input, output, and engine named in order, and zero filler wording. Nothing could be removed without losing information.

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

Completeness4/5

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

For a one-parameter, stateless transform with no output schema and no annotations, the description covers the essentials: what goes in, what comes out, and that the HTML is sanitized. Only minor gaps remain (which markdown constructs or raw HTML are permitted, and that the result is a plain HTML string).

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 100% for the single `text` parameter, so the schema already defines it as "Markdown text to render into sanitized GitHub Flavored HTML." The description adds essentially no new meaning beyond the schema — it is close to a restatement of the parameter definition and tool name.

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 names a specific verb and transformation ("Render Markdown text to sanitized HTML") plus the concrete engine and flavor ("GitHub-flavored markdown Redcarpet pipeline"), so an agent knows exactly what the tool produces. It does not explicitly differentiate from siblings, but the entire sibling set is todo/project/attachment management, so no confusion is realistically possible.

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 it should call this when markdown-to-HTML conversion is needed, but there is no explicit when-to-use framing, no prerequisites, and no mention of edge cases such as passing non-markdown input. Acceptable for a single-purpose utility, but no routing guidance is supplied.

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