Skip to main content
Glama

Markdown heading outline

bpj_heading_outline_check
Read-onlyIdempotent

Extract ATX headings outside fenced code and flag skipped levels.

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": {
      "markdown": "<markdown>"
    },
    "name": "bpj_heading_outline_check"
  }
}

Input Schema

NameRequiredDescriptionDefault
markdownYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false, so safety is covered. The description adds real behavioral detail the annotations do not: fenced code blocks are excluded from extraction and skipped heading levels are flagged. It stops short of describing what a 'flag' is or what the response contains.

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 ten-word sentence with the verb front-loaded and zero filler. Every clause carries information: extraction target, exclusion rule, and the secondary flagging behavior.

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

Completeness3/5

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

For a one-parameter, read-only, idempotent tool with no output schema, the description should still say what comes back — a heading list, a level hierarchy, or a violation report — and what 'flag skipped levels' produces. That omission leaves the agent unable to predict the result shape, though the input side is adequately covered.

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?

One required parameter at 0% schema coverage; the schema supplies only a title ('Markdown source') and a 10000-character maxLength. The description implies the input is markdown and that fenced code is treated specially, but does not explain the ATX ('#'-style) constraint, the character limit, or whether setext headings are ignored — a meaningful gap, since ATX-only extraction is a real semantic restriction.

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?

Specific verb and resource: 'Extract ATX headings outside fenced code and flag skipped levels' names the exact artifact (ATX headings), the exclusion rule (fenced code), and the secondary behavior (skipped-level flagging). It clearly reads as a heading-structure check, distinct from link, alt-text, or CSV siblings, though it never names an alternative 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?

No when-to-use, when-not-to-use, or alternative guidance appears. The agent must infer from the name that this is a documentation-quality check to run on markdown source, and gets no signal about whether to prefer it over any other outline or lint-style sibling.

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.