Skip to main content
Glama

Markdown teaser extraction

bpj_markdown_first_preview
Read-onlyIdempotent

Split a Markdown teaser from its continuation at a standalone more comment outside fenced code.

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

Input Schema

NameRequiredDescriptionDefault
textYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already establish readOnly, idempotent, non-destructive, closed-world behavior, so safety is covered. The description does add real behavioral content beyond that: the split only occurs at a standalone marker and is ignored inside fenced code. However, it does not disclose what happens when no marker exists (whole text returned? empty teaser?) or how multiple markers are handled, which matters for correct invocation.

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 front-loaded sentence with no filler; the operative constraint (standalone marker outside fenced code) is placed where the agent will read it first. Brevity is appropriate, though it borders on under-specification rather than tightness.

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

Completeness2/5

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

There is no output schema, so the description is the only place the agent could learn the return shape (two parts, fields, or ordering), and it never says. Combined with an undocumented parameter and no fallback behavior for a missing marker, the definition leaves too much unresolved for a tool whose whole job is a structural split.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% for the single parameter, so the description must carry the meaning of `text`. It only weakly implies the input is Markdown source and says nothing about the 6000-character limit, whether trailing whitespace is preserved, or how the marker line is treated. This is a case where the low coverage is not compensated.

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?

The description gives a specific verb ("split") and a specific resource ("Markdown teaser from its continuation") plus the exact splitting rule: a standalone more comment outside fenced code. That is enough for an agent to tell this apart from siblings like bpj_markdown_cut_section or bpj_markdown_frontmatter_split. The only weakness is the unexplained term "more comment", which the agent must infer means the teaser marker.

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 guidance on when to choose this over related Markdown tools, nor any statement of preconditions or exclusions. The description implies the task (extract a teaser) but leaves the agent to infer the use case entirely from the verb.

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.