Skip to main content
Glama
MCP Connect Starter

MCP Connect Starter

by cdtalley

read_doc

Reads one markdown document from the path returned by search_docs so you can inspect the full documentation content.

Instructions

Read one markdown document by the path returned from search_docs.

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": {
      "path": "<path>"
    },
    "name": "read_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes

Output Schema

NameRequiredDescriptionDefault
pathYes
titleYes
contentYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full disclosure burden. 'Read' implies a safe, non-mutating operation, but the description says nothing about behavior on an invalid or missing path, whether the full document is always returned, or any access/permission requirements. With no annotations to lean on, this is a real gap.

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 short sentence with no filler, and the key constraint (path provenance) is front-loaded. Size is well matched to a one-parameter tool.

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 trivial single-parameter read tool with an output schema that documents the return value, the description covers the essentials: what it returns conceptually and where the argument comes from. Only failure-mode behavior is absent, which is a minor omission at this complexity.

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 coverage is 0% — the sole parameter is documented only as a generic string titled 'Path'. The description partially compensates by stating the path must come from search_docs, which is genuinely useful provenance not present in the schema, but it omits format details (absolute vs relative, separators, extensions).

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?

Specific verb (Read), specific resource (one markdown document), and a specific scoping detail ('by the path'). It is clearly distinguishable from the search_docs sibling, which is named as the discovery step. It stops short of 5 only because the document format/scope beyond 'markdown' is not elaborated.

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?

It implicitly prescribes the workflow: obtain the path from search_docs, then call this tool. That is useful ordering guidance, but there are no explicit when-not conditions or mention of what to do if the path is stale or unknown.

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