Skip to main content
Glama

Read document

read_document
Read-only

Read one whole document from your own documents (your knowledge base), by the document_id and connection_id of a search or browse result. Returns its full text, title, date and metadata. A long document comes in parts: when the result has next_content_offset, call again with content_offset set to it. Free: reading never spends your balance.

Input Schema

NameRequiredDescriptionDefault
document_idYesdocument_id from a search or browse result (your own id from ingest).
connection_idYesconnection_id from the same result.
content_offsetNoOnly for a long document: next_content_offset from the previous part. Omit to read from the start.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint=true, destructiveHint=false, openWorldHint=false), so the bar is lower. The description adds real value beyond them: what gets returned (full text, title, date, metadata), the paginated read pattern, and the cost fact that reading never spends the balance.

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?

Three compact sentences, front-loaded with what the tool does, followed by the pagination mechanic and the cost note. No filler or restatement of the title.

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?

There is no output schema, yet the description enumerates the returned fields and explains how to page through a long document, which is exactly what an agent needs to call and drive this tool correctly.

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 all three parameters are already documented in the schema, including content_offset's 'next_content_offset from the previous part'. The description restates the pagination loop rather than adding new format or constraint detail, so the baseline 3 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?

Specific verb (Read) plus resource (one whole document from your own knowledge base) and the exact identifiers required. It implicitly separates itself from search_documents/browse_documents by naming them as the source of the ids, and from ask_documents by returning raw full text rather than an answer.

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?

It states the precondition (ids come from a search or browse result) and gives clear guidance for the long-document case, including the follow-up call with content_offset. It does not explicitly say when to prefer ask_documents over reading raw text, so an exclusion is missing.

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