Skip to main content
Glama
Sign In
mdgen-mcp

mdgen-mcp

by Shien-Inc
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Read document

read_document

Retrieve a document's full Markdown and metadata using its ID. Provides the complete content needed for reading and processing documents.

Instructions

Get the full Markdown and metadata of a document by id.

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": {
      "id": "<id>"
    },
    "name": "read_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesDocument id

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.3

TDQS

A3.8/5.0
Behavior3/5

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

With no annotations, the description carries the full burden of behavioral disclosure. It does reveal what the tool returns (full Markdown and metadata), but it does not mention error behavior, permissions, or side effects. Since this is a read-only operation, the lack of mutation details is acceptable, but other aspects like not-found handling are undisclosed.

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 that directly communicates the core function without extra words. It is concise and well-structured for quick parsing.

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 single-parameter read tool, the description adequately covers what the tool does (returns full Markdown and metadata). It lacks explicit mention of errors or prerequisites, but given the simplicity and absence of an output schema, it is reasonably complete. A slight deduction for not noting behavior on missing documents.

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?

The schema already documents the only parameter 'id' with a description, and the tool description adds no further meaning beyond 'by id'. Schema description coverage is 100%, so the baseline is 3; there is no additional semantic value from the description.

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 clearly states the action ('Get') and the resource ('a document by id'), specifying that it returns 'full Markdown and metadata'. This differentiates it from sibling tools like list_documents (which lists all) and create/update/delete (which modify).

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 description implies usage for retrieving a single document by ID, but it does not explicitly state when to choose this over list_documents or mention any prerequisites or exclusions. The context is clear enough to infer, but explicit guidance is absent.

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