Skip to main content
Glama

Markdown reference definition index

bpj_markdown_reference_index
Read-onlyIdempotent

List single-line Markdown link reference definitions and their destinations outside fences.

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

Input Schema

NameRequiredDescriptionDefault
textYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.5/5.0
Behavior3/5

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

The annotations already declare the tool as read-only, idempotent, non-destructive, and closed-world. The description adds useful behavioral scope by saying it only handles single-line definitions and ignores fenced content, but it does not describe output shape, duplicate handling, malformed references, or error behavior.

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?

The description is a single front-loaded sentence with no filler. Every phrase contributes to defining the resource or its scope.

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 simple listing tool with strong annotations and no output schema, the description adequately states what is returned in concept: definitions and destinations. It is slightly incomplete because it does not characterize the return structure or clarify edge cases such as duplicate or malformed definitions.

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?

The schema has one required parameter, 'text', with 0% description coverage. The tool description never mentions the input parameter or explains that it expects Markdown source text, so it does not compensate for the missing schema documentation beyond implicitly establishing Markdown context.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb and resource: it lists single-line Markdown link reference definitions and their destinations. The 'outside fences' qualifier scopes the operation and helps distinguish it from broader Markdown coverage or structural index tools.

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 gives no explicit when-to-use guidance, prerequisites, or named alternatives. 'Outside fences' implies a scope constraint, but the agent is left to infer when this listing tool is preferable to related reference or coverage tools.

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.