Skip to main content
Glama
Local Development MCP Server

Local Development MCP Server

by lreb

generate-markdown-doc

Creates a structured markdown document from a title and sections with headings and content, so you can produce formatted docs without writing markup by hand.

Instructions

Generate a markdown document with specified structure

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": {
      "title": "<title>",
      "sections": "<sections>"
    },
    "name": "generate-markdown-doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
titleYesDocument title
sectionsYesSections with headings and content

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.0

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations, the description carries the full burden and does not disclose whether the generated document is written to disk, returned as a string, or saved to a path — and there is no path parameter, which raises the question. It also says nothing about overwrite behavior, validation, or output format. These are material gaps for a generation tool with zero annotation coverage.

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?

A single short sentence with no redundant wording, and the core action is front-loaded. It is efficient but borders on under-specification rather than economy of expression.

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

Completeness2/5

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

The tool is simple (2 required params, no annotations, no output schema), so the bar is low, but the most important unknown for a generator — whether it returns markdown or persists a file, and where — is unresolved. The description should close that gap and does not.

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%, so both parameters (title, sections with nested heading/content) are already fully documented in the schema. The description adds nothing beyond that, so baseline 3 applies.

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 and resource ("Generate a markdown document") and adds that the structure is specified by the caller. It is intelligible on its own, but it never distinguishes itself from siblings like write-file or generate-readme, so the agent cannot tell which one to pick.

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

Usage Guidelines2/5

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

There is no when-to-use guidance, no mention of when not to use it, and no reference to the obvious alternatives (write-file, generate-readme). The agent must infer the selection rule entirely from the tool name.

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