Skip to main content
Glama

markdown

Lint, outline, build GitHub-style TOCs, check file and anchor links, and format tables in .md files.

Instructions

Markdown: lint, outline, toc (GitHub anchors), links (checks files and #anchors), format_tables.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "markdown"
  }
}

Input Schema

NameRequiredDescriptionDefault
opNo
pathNoor a file
textNo
in_placeNo
out_pathNo
max_levelNo
min_levelNo
overwriteNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.2

TDQS

C2.4/5.0
Behavior2/5

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

Annotations supply only destructiveHint=false, so the description carries the burden for the rest, yet it never mentions that in_place/overwrite write to disk, whether lint/links report failures or exit non-zero, or what output looks like without out_path. The presence of in_place and overwrite parameters with zero explanation leaves genuinely risky write behavior undisclosed.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

It is a single compact, front-loaded line with no padding, which is good, but the terse op-list style is under-specification rather than efficient communication. The parentheticals are unevenly applied, giving depth to toc and links while leaving other ops bare.

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?

For an 8-parameter multiplexer with no output schema and near-zero schema documentation, this definition leaves an agent unable to call it correctly beyond guessing. It needs at minimum per-op parameter applicability and a note on write behavior.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 13% across 8 parameters, so the description must compensate and does not: op is listed via its enum values, but path, text, in_place, out_path, max_level, min_level, and overwrite receive no explanation at all. max_level/min_level in particular are unguessable without context (heading depth for outline/toc?).

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose3/5

Does the description clearly state what the tool does and how it differs from similar tools?

"Markdown: lint, outline, toc, links, format_tables" enumerates the five operations, so the tool's domain is inferable, but no verb+resource statement explains that it is a Markdown analysis/formatting utility operating on a file or inline text. The parenthetical "toc (GitHub anchors)" and "links (checks files and #anchors)" add specifics for two ops only.

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 guidance on when to pick each op, when to pass path vs text, or when to use in_place versus out_path. The only usage-like signal is the embedded note that links checks files and #anchors, which covers one of five operations.

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