Skip to main content
Glama

Markdown hard break locations

bpj_markdown_hard_break_positions
Read-onlyIdempotent

Locate nonblank lines outside fences ending in at least two spaces or a backslash.

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

Input Schema

NameRequiredDescriptionDefault
textYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description adds real filtering semantics beyond that: fenced blocks are excluded, blank lines are excluded, and hard breaks are defined as trailing two spaces or a backslash. It does not, however, say what a 'position' consists of (line number, offset, matched text), and there is no output schema to fill that gap.

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?

A single dense sentence with the exclusion rules front-loaded and no filler. The trailing clause 'ending in at least two spaces or a backslash' is slightly elliptical about what is ending, but the sentence earns its length.

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 simple one-parameter read-only scanner with rich annotations, the definition covers what is detected and what is skipped, which is the core need. The missing piece is return-value shape — since no output schema exists, the description should say whether positions are line numbers, character offsets, or the matched lines themselves.

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 one parameter, 'text', with 0% schema description coverage, but its meaning is effectively self-evident from the tool purpose and the 'Source text' title in the schema. The description implies Markdown input without specifying handling of line endings, very long documents, or the 6000-character cap, so it adds only modest meaning beyond the schema.

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 ('Locate') and a precisely defined resource: nonblank lines outside fences that end in two-plus spaces or a backslash. An agent can tell this is a Markdown hard-break detector, distinct from sibling scanners like fence coverage or horizontal dividers, 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 defines the matching criteria but gives no when-to-use context, no prerequisites, and no pointer to related tools such as fence_coverage or escape_inline. Usage is only inferable from the detection rule itself.

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.