Skip to main content
Glama

Markdown linked contents

bpj_markdown_toc_list
Read-onlyIdempotent

Build an indented linked contents list from ATX headings using deterministic local slugs.

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": "bpj_markdown_toc_list"
  }
}

Input Schema

NameRequiredDescriptionDefault
textYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnly, idempotent, closed-world, non-destructive), so the description only needs to add behavior — and it does, disclosing that slugs are local and deterministic and that only ATX headings are considered. It still omits how duplicate headings or the 6000-character input cap are handled.

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 verb first and zero filler. Every phrase — indented, linked, ATX headings, deterministic local slugs — carries meaning.

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, no-output-schema utility, the description covers both the transformation and the shape of the result well enough to call it correctly. The remaining gap is edge-case behavior (duplicate headings, size limit) rather than anything blocking invocation.

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?

With one parameter at 0% schema coverage, the schema only supplies a title, type, and maxLength. The description compensates partly by implying the input is Markdown containing ATX headings, but it never mentions the text parameter, the size limit, or expected input shape directly.

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 artifact: "Build an indented linked contents list from ATX headings." Naming ATX headings and deterministic local slugs separates it from sibling heading tools such as bpj_markdown_heading_collisions or bpj_markdown_internal_fragments, though no sibling is named explicitly.

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?

The description says what the tool produces but never when to reach for it versus alternatives (e.g. internal-fragment checking or heading-collision detection). There are no prerequisites, exclusions, or conditional guidance, leaving the agent to infer usage from the title alone.

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.