Skip to main content
Glama

Markdown section index

bpj_markdown_section_index
Read-onlyIdempotent

Index ATX headings outside fences with line numbers, levels and unique local anchor suggestions.

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_section_index"
  }
}

Input Schema

NameRequiredDescriptionDefault
textYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, closed-world and non-destructive, so the safety profile is covered. The description adds real substance beyond that: only ATX headings are considered, fenced regions are skipped, and anchors are made unique and local — behavioral details not present in any structured field.

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?

One dense sentence with the scope constraint ('outside fences') and the output fields front-loaded; no filler, no repetition of the title.

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, read-only analysis tool with no output schema, the description adequately covers scope and what is returned. The gaps are the undisclosed 6000-character input cap and behavior on edge cases such as duplicate or empty headings.

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?

There is a single required parameter with 0% schema description coverage, so the description should compensate. It never mentions the source text or the maxLength of 6000, which is a meaningful constraint an agent could trip over. The obviousness of a one-param text input keeps this at a baseline 3.

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 ('Index') and a precise resource ('ATX headings outside fences'), and enumerates the produced fields (line numbers, levels, unique local anchor suggestions). This is clearly distinct from siblings like heading_collisions or shift_heading_levels, 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 Guidelines3/5

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

Usage is only implied: producing a heading index suggests TOC generation or heading auditing, but the description never states when to pick this over bpj_markdown_heading_collisions or bpj_markdown_setext_to_atx. No prerequisites or exclusions are given.

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.