Skip to main content
Glama

read_document

Read-onlyIdempotent

Retrieve and display document content. Optionally paginate by line range to read specific sections or the full document for quoting or review.

Instructions

    Retrieves and displays document content, optionally
    paginated by line range.

    Use this tool when you need to:
    - Access the complete content of a specific document
    - Read a specific range of lines from a large
      document
    - Review document information in detail
    - Quote or reference document content

    When offset or limit are set, output includes line
    numbers and a metadata header showing the range.
    When both are 0 (default), the full document is
    returned in the original format for backward
    compatibility.

    Args:
        document_id: The document ID to retrieve
        offset: 0-based line number to start from;
            must be non-negative (default: 0)
        limit: Number of lines to return; 0 means all
            lines; must be non-negative (default: 0)

    Returns:
        Formatted string containing the document title
        and content
    

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNo
offsetNo
document_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

Annotations already declare read-only and idempotent. Description adds that output includes line numbers and metadata header when paginated, and full document format for backward compatibility when offset and limit are default. No contradiction.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Description is well-structured with sections and front-loaded purpose. Slightly verbose with Returns line stating the obvious, but overall concise and clear.

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?

Given 3 params (1 required), output schema, and annotations, description covers behavior, parameters, and return format. Could mention error handling or edge cases, but sufficient for a read tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema has 0% description coverage. Description provides detailed Args: document_id (ID to retrieve), offset (0-based, non-negative, default 0), limit (number of lines, 0 means all, non-negative, default 0). Adds significant meaning beyond schema types.

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?

Description clearly states it retrieves and displays document content, optionally paginated. Distinguishes from siblings like read_document_section by specifying line range vs section focus.

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?

Explicitly lists use cases: access complete content, read specific range, review details, quote/reference. No direct mention of when not to use, but context with sibling tools makes it clear.

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/Vortiago/mcp-outline'

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