Skip to main content
Glama

read_doc_contents

Retrieve a document's contents as a string by providing its ID.

Instructions

Read the contents of a document and return it as a string.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
doc_idYesID of the document to read.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden. It states that the operation is a read and that it returns a string, which is useful given the lack of an output schema, but it omits permissions, error behavior, and handling of large or binary documents.

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 a single front-loaded sentence with no wasted words. It states the operation and the return type directly.

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 simple one-parameter read tool with complete schema coverage and no output schema, the description is nearly sufficient: it identifies the action and the return format. It could be more complete by routing the agent relative to edit_document, but the remaining gap is minor.

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 doc_id parameter is already documented in the schema. The description adds no additional meaning such as ID format or accepted values, matching the baseline of 3 when the schema does the heavy lifting.

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 and resource: read a document's contents and return it as a string. It is clear what the tool does, though it does not explicitly distinguish itself from the sibling edit_document.

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

Usage Guidelines2/5

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

No when-to-use guidance is provided. It does not mention the sibling edit_document or any conditions under which reading should be preferred over editing. The operation is implied by the tool name, but the description itself offers no routing advice.

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

Deploy Server

Other Tools