Skip to main content
Glama

Read document

read_document
Read-onlyIdempotent

Use this when the user needs structured document content from a PDF, DOCX, XLSX, CSV, JSON or XML file on a paired computer. Returns extracted content and bounded metadata from the document path.

Input Schema

NameRequiredDescriptionDefault
pathYesDocument path.
sheetNoWorksheet name for XLSX.
deviceYesReMCP device id returned by list_devices. Required for every device operation.
max_cellsNoMaximum number of spreadsheet cells to return.

Output Schema

NameRequiredDescriptionDefault
dataNoRead document structured result for read_document. Stable fields are declared explicitly; platform-specific fields may be added. Large results may return truncated/bytes/preview instead of the full payload.
textYesConcise human-readable result of the tool call.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added
  2. Removed
  3. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare the full safety profile (readOnlyHint, idempotentHint, non-destructive), so the burden is light. The description adds only 'extracted content and bounded metadata' and the paired-computer scope, without disclosing truncation behavior, size limits, or auth/prerequisite needs for the device. Useful but thin.

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?

Two sentences, front-loaded with the use trigger and format list, no filler. 'Bounded metadata' is slightly jargon-y but the whole thing is tight and earns its space.

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?

With an output schema present, return values need not be explained, and the annotations carry the safety profile; the description covers format coverage, source, and a use trigger. Only the sibling-routing gap and device prerequisites keep it from being fully complete.

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 100%, so the schema itself documents path, sheet, device, and max_cells. The description only echoes 'document path' and adds no syntax, format, or range meaning beyond the schema, so the baseline 3 applies.

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 ('read') and resource ('document') and enumerates the supported formats (PDF, DOCX, XLSX, CSV, JSON, XML) plus the source ('paired computer'). It stops short of distinguishing itself from close siblings like read_file, read_files, or pdf_extract_pages, so an agent still has to infer which reader to pick.

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 gives a clear use condition ('when the user needs structured document content'), which is more than implied usage. But it names no alternatives and no exclusions, so the agent gets no guidance on when to prefer read_file or a pdf_* sibling instead.

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