Skip to main content
Glama

Setext to ATX headings

bpj_markdown_setext_to_atx
Read-onlyIdempotent

Convert plain title lines immediately followed by Setext equals or hyphens to ATX headings.

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

Input Schema

NameRequiredDescriptionDefault
textYes

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 readOnly, idempotent, non-destructive and closed-world, so safety is covered. The description adds the conversion rule itself, which is real behavioral value, but says nothing about what happens to non-matching lines (presumably unchanged) or about the 6000-character input ceiling.

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 sentence with zero filler. The trigger condition (title line plus equals/hyphen underline) is front-loaded, so an agent can decide relevance immediately.

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 small, single-parameter, side-effect-free text transform with annotations covering safety, the definition is adequate but thin: it never says the result is returned text with everything else preserved, and it omits the input size limit. No output schema exists, so describing the return value would have been worthwhile.

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 parameter, 'text', with 0% schema description coverage, so the description should carry the burden. It implies the input is Markdown source containing title lines, but never mentions that the whole document is passed in or what limits apply; the schema's title and maxLength do that work. Marginal added meaning.

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 concrete transformation (Setext headings -> ATX headings) with the precise trigger condition: a plain title line immediately followed by an equals or hyphen underline. That is enough to distinguish it from the other bpj_markdown_* siblings. It stops short of naming a sibling or stating scope of the rest of the document, so it is clear but not sibling-differentiating.

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 when-to-use or when-not-to-use guidance and no alternative named. The agent must infer from the tool name and the other bpj_markdown_* tools that this is one of several Markdown normalization utilities.

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.