Skip to main content
Glama

extract_markdown_toc

Extract a table of contents from Markdown text to list headings and subheadings, providing a clear document outline.

Instructions

Extract table of contents from a Markdown document

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
markdownYesMarkdown text
Behavior2/5

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

With no annotations, the description carries the full burden of behavioral disclosure. It only states the action but does not describe the output format, whether nested headings are included, how the TOC is structured, or any edge-case behavior. This leaves the agent uncertain about the return value.

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?

The description is a single, clear sentence with no wasted words. It is appropriately short for a tool with one parameter, though it omits useful output details.

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?

Given there is no output schema, the description must explain what the tool returns. It does not, leaving the result type and structure ambiguous. For a tool with one input, this is a significant gap in completeness.

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 describes the only parameter 'markdown' as 'Markdown text' (100% coverage). The description adds no additional meaning beyond that, so the baseline score of 3 applies.

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

Purpose5/5

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

The description clearly states the tool extracts a table of contents from a Markdown document. It uses a specific verb ('Extract') and resource ('table of contents'), making it distinct from siblings like markdown_to_html or extract_from_text.

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?

No guidance is provided about when to use this tool versus alternatives. It does not mention any prerequisites, exclusions, or compare with other tools that might handle Markdown content.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/RockaRhymeLLC/bmobot-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server