Skip to main content
Glama

read_doc_contents

Retrieve document contents by ID, returning the text as a string for use in chat interactions.

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 present, so the description carries the burden. It communicates the core read-only action and return format, but omits details about error handling, permissions, or potential side effects. The term 'read' implies safety, but this is not explicitly stated.

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 that efficiently states the action and return type. No superfluous words or redundant information, making it highly concise.

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 tool with one parameter and no output schema, the description covers the essentials: what it acts on and what it returns. It lacks error handling details, but given the low complexity, it is sufficiently complete for basic usage.

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 input schema already provides a complete description of the doc_id parameter (100% coverage). The tool description adds no additional parameter semantics, so the baseline score of 3 is appropriate.

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 clearly states the action ('read'), the resource ('document'), and the return type ('string'). It distinguishes itself from siblings like edit_doc_contents and add_ints by focusing on retrieval, making the purpose unambiguous.

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 for reading documents but does not explicitly compare with edit_doc_contents or specify when to choose this tool over alternatives. The context is clear from the verb, but no direct guidance is given.

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/gfalbarracinr/cli_project'

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