Skip to main content
Glama

Escape inline Markdown punctuation

bpj_markdown_escape_inline
Read-onlyIdempotent

Backslash-escape ASCII punctuation permitted by CommonMark for use as literal inline text.

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

Input Schema

NameRequiredDescriptionDefault
textYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds useful behavioral scope by pinning the escape set to CommonMark-permitted ASCII punctuation and limiting it to inline use, but it says nothing about what the returned string looks like or how pre-existing backslashes are treated.

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 zero filler; the verb and the constrained escape set come first. It is almost too terse, reading as a fragment rather than a complete statement of effect, which slightly limits structure.

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, non-destructive string transform with rich annotations, the description is adequate on input side but stops short of describing the returned value (escaped text) with no output schema to fall back on. An agent can call it correctly, but cannot fully predict the result format.

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?

Schema description coverage is 0%, so the description must carry the parameter explanation. It does indicate that the input is the source text to be escaped as literal inline text, which gives the single 'text' parameter meaning, but it omits the 6000-character maxLength constraint and any hints about what the escaped output contains.

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 states a specific verb+resource: 'Backslash-escape ASCII punctuation permitted by CommonMark', scoped to 'literal inline text'. It is clearly distinguishable in intent from siblings like bpj_unicode_escape_sequence or bpj_markdown_inline_code_wrapper, but it never names or contrasts any of them 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?

The phrase 'for use as literal inline text' implies the use case (make punctuation render literally instead of being parsed as Markdown), so an agent can infer when to call it. However, there is no explicit when-not guidance, no mention of the inline-vs-block distinction as a selection criterion, and no named alternative such as fenced code or unicode escaping.

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.