Skip to main content
Glama

markdown_stats

Read-onlyIdempotent

Analyze Markdown text to count headings, links, code blocks, words, and other elements for content review or validation.

Instructions

Analyze Markdown text: count headings, links, code blocks, words, and more.

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": {
      "markdown": "<markdown>"
    },
    "name": "markdown_stats"
  }
}

Input Schema

NameRequiredDescriptionDefault
markdownYesMarkdown text to analyze.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.1.11

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveness, so the safety profile is covered by structured data. The description adds that this works on raw Markdown input, but 'and more' is opaque and nothing is said about how the analysis is scoped (e.g., whether inline code, HTML blocks, or front matter are counted), which materially affects the numbers returned.

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?

One short sentence, front-loaded with the action and resource, with no padding. The trailing 'and more' is the only weak element, since it is vague rather than informative.

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?

No output schema exists, so the description must carry the return-value burden; it names a partial metric list and leaves the rest as 'and more'. An agent knows roughly what to expect but cannot state exactly which statistics come back, which matters for a pure-report tool.

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 a single required parameter with 100% schema coverage and a clear description ('Markdown text to analyze'). The tool description adds no format guidance beyond what the schema provides, so the baseline 3 applies.

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 and resource ('Analyze Markdown text') and enumerates concrete metrics (headings, links, code blocks, words), so the agent knows the output shape is a statistics breakdown. It does not distinguish itself from nearby siblings such as word_count, text_analyse, or readability_score, which also analyze text, so it falls short of a 5.

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?

Usage is only implied: the scope word 'Markdown' hints this is for Markdown documents rather than plain text. There is no explicit when-to-use or when-not, and no routing to the obvious alternative (word_count for plain word counts, text_analyse for generic text metrics).

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools