Skip to main content
Glama
Sign In
criticmarkup

criticmarkup

by Martennnnn
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

get_md_contents

Reads a Markdown file, returns prose up to a configured cutoff, then summarizes discussion comment threads while hiding YAML frontmatter.

Instructions

Reads a markdown file, returning prose up to the user-configured cutoff line (if set), followed by an abbreviated summary of discussion comment threads. YAML frontmatter is completely hidden from view.

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": {
      "filepath": "<filepath>"
    },
    "name": "get_md_contents"
  }
}

Input Schema

NameRequiredDescriptionDefault
filepathYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.5/5.0
Behavior4/5

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

With no annotations, the description carries the full behavioral burden and does disclose non-obvious lossy behavior: output is truncated at a user-configured cutoff line, comment threads are only summarized, and YAML frontmatter is fully hidden. It does not cover failure behavior for a missing/unreadable filepath or any size limits.

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?

Three short sentences, front-loaded with the primary action and its return shape before moving to the two edge behaviors (cutoff comment summary, hidden frontmatter). No repeated or filler wording.

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?

An output schema exists, so return values need not be spelled out, and the lossy-content behaviors are well covered. However, with zero annotation coverage the description should also address the filepath contract and error/edge cases for a tool whose only input is a path, and it does not.

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?

There is one required parameter, 'filepath', with 0% schema description coverage, so the description must compensate - but it says nothing about the path's expected format (relative vs. absolute), its base directory, or file extension requirements. The single most important input is left completely undefined.

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 and resource ('Reads a markdown file') and details what is returned: prose up to a cutoff line plus an abbreviated summary of comment threads. That clearly separates it from the sibling tools, all of which are write/mutation operations (write_comment, replace_all, request_changes), though the description never explicitly frames itself as the read counterpart.

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 by the verb 'Reads' - an agent can infer this is the tool for viewing an existing markdown file, but there is no statement of when to prefer it over alternatives, no prerequisites, and no stated exclusions or limits on which files it applies to.

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