Skip to main content
Glama

read_doc

Retrieve the full contents of a document by providing its ID. Access the exact text you need.

Instructions

Read the contents of a document.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
doc_idYesThe ID of the document to read.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior2/5

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

There are no annotations to cover safety or side-effect information, and the description only restates the core operation without addressing permissions, errors, output format, or whether the operation is side-effect-free. The agent is left to infer most behavioral properties from the word 'read'.

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 clear sentence with no filler or redundancy. It is appropriately concise for the simplicity of the tool.

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

Completeness3/5

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

Given the tool's simplicity)Skip—one parameter and a single straightforward action—the description provides minimal viable context. However, with no annotations or output schema, a bit more detail about return format or typical usage would make it 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 baseline is adequate. The description adds no extra meaning beyond the schema's doc_id parameter, but it does not need to compensate for missing parameter documentation.

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 is a clear, specific verb+object statement ('Read the contents of a document'), and the sibling tool name edit_doc reinforces the distinction between reading and editing. An agent can tell exactly what operation this tool performs.

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?

There is no guidance about when to prefer this tool over alternatives, prerequisites, or typical use cases. The intended usage is only implied by the tool's name and minimal description, so an agent gets no explicit context about selection or invocation.

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

Install Server

Other Tools