Skip to main content
Glama

read_doc_contents

Retrieve a document's full text by providing its ID, and get the content returned as a string for use in chat.

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
Behavior3/5

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

No annotations are provided, so the description carries the transparency burden. It discloses that the operation is a read and returns a string, but it does not mention error behavior, permissions, or side effects. The word 'read' implies a non-mutating operation, which is helpful, but additional context is missing.

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 wasted words. It is front-loaded with the core action and result, adhering to conciseness.

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 read tool with one parameter and no output schema, the description provides adequate context: it states what it does and the return type. However, it omits details like error conditions or pagination limits, which a comprehensive description might include. Still, within the tool's simplicity, it is largely 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?

The schema covers the only parameter 'doc_id' with a description ('id of the document to read'), giving 100% coverage. The description adds no extra meaning beyond the schema, so the baseline score of 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?

The description uses a specific verb ('read') and a specific resource ('document') and clearly states the output format ('return it as a string'). It distinguishes itself from the sibling tool 'edit_document' by focusing on read vs. modify behavior.

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?

The description implies usage by contrasting with the sibling 'edit_document' (read vs. edit), but it does not explicitly state when to use this tool or provide exclusions/alternatives. The context is clear but not explicit, so it falls under 'implied usage'.

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

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/inissaka/Intro-to-MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server