Skip to main content
Glama

read_document

Read-only

Read the full content of a document by its ID. Returns the title, content (HTML), plain text, and metadata.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
document_idYesThe document ID to read

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations already establish read-only, non-destructive behavior. The description adds meaningful behavioral detail by stating exactly what a successful call returns, including that content is HTML plus plain text and metadata. It does not cover errors or size limits, but for a simple read operation this is sufficient.

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?

A single focused sentence front-loads the verb and object, then lists the return payload types. Every clause earns its place with no filler, redundancy, or unnecessary background.

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 one-parameter read tool with read-only annotations and an output schema, the description is nearly complete. The only notable gap is the absence of explicit routing relative to siblings like list_documents or search_documents, so agents must infer when this tool is the right choice.

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 input schema already fully documents document_id at 100% coverage. The description only repeats the obvious 'by its ID' relationship and adds no new parameter-level detail, so the schema carries the semantic weight and the baseline score applies.

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?

States a clear action ('Read'), exact resource ('document'), retrieval scope ('full content'), and the key selector ('by its ID'). Enumerating the returned data (title, HTML content, plain text, metadata) further distinguishes it from list, search, and creation tools even without naming a sibling.

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 when to use the tool: when the agent has a document ID and needs the full document content. However, it gives no explicit when-to-use/when-not-to-use guidance or alternatives such as list_documents or search_documents, leaving the routing decision mostly to inference.

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