Skip to main content
Glama
Sign In

ThreadPage

by page.thread
OverviewDiscussionsAdmin

Read a file in a note

read_note_file
Read-onlyIdempotent

Read a file in a Note: its text for text files and PDFs (up to 1 MB; truncated says it was cut), a preview for images and video, details for other files. Text or a preview still being prepared answers timed_out: retry after details.retry_after; previews count toward the image preview limits. An image listed in get_note's images is read with read_note_attachment; to add a file, use upload_note_file.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "note_id": "<note_id>",
      "file_id": "<file_id>"
    },
    "name": "read_note_file"
  }
}

Input Schema

NameRequiredDescriptionDefault
file_idYesA file's id, from get_note's document or files.
note_idYesA Note's id, from get_thread, search or get_note.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Beyond the readOnly/idempotent/non-destructive annotations, the description discloses a 1 MB truncation limit with signaling ('truncated says it was cut'), the timeout failure mode with a retry field, and that previews consume image preview quotas. These are operational constraints an agent cannot infer from the annotations or schema.

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?

Front-loads purpose, then constraints, then sibling routing — a sensible order with no filler sentences. The first sentence is dense with nested parentheticals ('up to 1 MB; truncated says it was cut'), slightly hurting scannability, but 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, yet the description explains the return shape per file type, the truncation marker, and the timeout envelope — covering exactly what would otherwise be missing. For a two-required-parameter read tool this is 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?

Schema description coverage is 100% and both parameters (note_id, file_id) already document their provenance (get_note's document or files, get_thread/search/get_note). The description adds no syntax or format detail beyond the schema, so 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?

Names a specific verb and resource ('Read a file in a Note') and immediately enumerates what is returned per file type: text for text/PDF, preview for images and video, details otherwise. It also explicitly distinguishes itself from read_note_attachment and upload_note_file, so an agent can pick the right tool 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 Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit routing rules: images listed in get_note's images go to read_note_attachment, and adding a file goes to upload_note_file. It also states the recovery path for a timed_out response (retry after details.retry_after), which is exactly the conditional guidance an agent needs.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All ThreadPage toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources