Skip to main content
Glama

read_document

Read-only

Read a published site markdown document by path, such as /index.md, /pricing.md or /auth.md.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
markdownYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.1/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, covering the safety profile. The description adds the context that the tool reads from published site documentation, which is useful, but it does not mention behaviors like 404 handling, frontmatter handling, or whether the returned content is raw markdown or rendered HTML. Still, for a read-only retrieval tool the annotation coverage means the burden is lower.

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 one compact sentence with concrete examples. It is front-loaded with the action and target, and every word earns its place. No redundancy or filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has only one parameter, a clear output schema exists to explain return values, and annotations already declare read-only safety. Given this simplicity, the description is sufficient for an agent to invoke it correctly. The examples and path-based semantics complete the picture.

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 description coverage is 0%, so the description fully explains the 'path' parameter's meaning: it should be a markdown path like /index.md, /pricing.md, or /auth.md. However, the description does not specify path constraints beyond the schema's maxLength, and does not explain what happens for invalid or non-markdown paths. Baseline 3 is appropriate because the description compensates for the missing schema 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 tool's function: reading a published site markdown document by path. It provides concrete examples like /index.md, /pricing.md and /auth.md, which immediately disambiguate it from sibling tools like list_services and search_docs. The verb 'read' plus the resource ('published site markdown document') is specific and actionable.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies the tool is for retrieving markdown content given a path, and the examples strongly suggest when to use it. It does not explicitly discuss when not to use it or recommend an alternative, but in context of siblings (list_services, search_docs), the use case is clear enough for an agent.

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.

Resources