Skip to main content
Glama

read_document_content

Read-onlyIdempotent

Read the body of a workspace document by id (markdown/text drafted by the agent or a human). Complements get_document_metadata (metadata) and draft_document (create). Text returns decoded; binaries return a download pointer; >8 MB returns metadata only. Caller must have project visibility.

Input Schema

NameRequiredDescriptionDefault
documentIdYesThe workspace document id.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already cover the safety profile, and the description still adds substantial non-obvious behavior: text is returned decoded, binaries yield a download pointer, and documents over 8 MB return metadata only. It also states the authorization precondition ('Caller must have project visibility'), which the annotations do not convey.

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?

Four short sentences, each carrying distinct information: identity, sibling roles, return-shape branches, and access requirement. The core action is front-loaded and nothing is redundant.

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, so the description carries the burden of explaining return values, and it does so across all three cases (decoded text, download pointer, oversize metadata-only). Combined with the visibility prerequisite, an agent has everything needed to call and interpret the result.

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?

With 100% schema description coverage on the single documentId parameter, the schema already does the heavy lifting. The description only restates 'by id' and does not add format, source, or lookup guidance, 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?

States a specific verb (read) and resource (workspace document body) and immediately bounds the content type as markdown/text authored by an agent or human. It explicitly distinguishes itself from get_document_metadata and draft_document, so an agent can route without opening any schema.

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?

Names both adjacent siblings with their roles ('get_document_metadata (metadata)', 'draft_document (create)'), which effectively tells the agent when this tool is the right one. It stops short of an explicit when-not clause (e.g., use list_documents first to find an id, or update_document_content to modify), so it is strong but not fully exhaustive.

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.