Skip to main content
Glama

Read

fetch
Read-onlyIdempotent

Reads a note, an app file, an app's data.json or a file, with line numbers (cat -n). Long text is read in parts: offset is the first line, limit how many (default 2000). A folder reads as its listing. Files: text files (TXT, CSV, JSON, code) as text you can edit; PDFs, Word, Excel and PowerPoint as their text; pictures as images. raw: true returns the file itself (base64, up to 10 MB).

Input Schema

NameRequiredDescriptionDefault
idYesA path, as list and search show them: "Work/Acme.md", a folder "Work/", a sub-note "Work/Acme/Agenda.md", a note's file "Work/Acme/contract.pdf", a file in a folder "To read/Paper.pdf", an app's file "Work/Habits.app/src/App.tsx" or its data "Work/Habits.app/data.json".
rawNoA file's own bytes, as a resource (base64). Up to 10 MB.
limitNoHow many lines.
offsetNoFirst line (1-based).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changed
    • changedInput schema / properties / id / description
      Previous value: -"Note id."New value: +"A path, as list and search show them: \"Work/Acme.md\", a folder \"Work/\", a sub-note \"Work/Acme/Agenda.md\", a note's file \"Work/Acme/contract.pdf\", a file in a folder \"To read/Paper.pdf\", an app's file \"Work/Habits.app/src/App.tsx\" or its data \"Work/Habits.app/data.json\"."
    • addedInput schema / properties / limit
      Added value: +{
      +  "description": "How many lines.",
      +  "type": "integer"
      +}
    • addedInput schema / properties / offset
      Added value: +{
      +  "description": "First line (1-based).",
      +  "type": "integer"
      +}
    • addedInput schema / properties / raw
      Added value: +{
      +  "description": "A file's own bytes, as a resource (base64). Up to 10 MB.",
      +  "type": "boolean"
      +}
  2. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already confirm readOnly, idempotent, non-destructive, and closed-world behavior. The description goes well beyond that by disclosing line-number formatting (cat -n), default pagination limit (2000), folder-listing behavior, text extraction from PDFs/Word/Excel/PowerPoint, image rendering, and raw base64 output capped at 10 MB.

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 dense but front-loaded, moving from core read behavior to pagination, folder handling, file types, and raw mode without wasted sentences. Each clause carries distinct operational information for an agent.

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?

For a four-parameter read tool with no output schema, the description is complete enough: it explains resource scoping, pagination, file-type conversions, folder behavior, and raw output limits. Annotations already cover safety and idempotency, so the remaining gaps are negligible.

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

Parameters4/5

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

Schema coverage is 100%, so parameter names and basic meanings are already documented. The description adds useful semantics beyond the schema: offset is the first line, limit defaults to 2000, raw true returns the file itself as base64, and line-oriented reads behave like cat -n.

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 states a specific verb ('Reads') and enumerates the exact resources it can read: a note, an app file, an app's data.json, a file, or a folder listing. It distinguishes the tool from siblings by focusing on content retrieval, including line numbers and file-type-specific rendering, so an agent can tell it apart from write/list/search operations.

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?

The description provides clear context for when this tool is useful: reading note/file contents, reading long text in parts via offset/limit, listing a folder, and handling different file types. It does not explicitly state when to use fetch instead of list or search, but the reading scenarios are clearly implied and no misleading exclusions are present.

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.