Skip to main content
Glama

file_read

Read-onlyIdempotent

Read file bytes as UTF-8 text using offsets, limits, and content hashes; continue partial reads and route binary files through artifact paths.

Instructions

Read bytes as UTF-8 text with byte offsets, content hash and explicit continuation. Binary files use artifact paths.

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": {
      "task_id": "<task_id>",
      "path": "<path>"
    },
    "name": "file_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes
limitNo
offsetNo
task_idYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so safety is covered. The description adds real value beyond them by disclosing UTF-8 decoding, a content hash, and 'explicit continuation' for chunked reads. However, it never explains how continuation works, whether offset/limit define a window, or what happens at end-of-file, which matters for a paging tool.

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?

Two short sentences, front-loaded with the core operation and free of filler. The telegraphic phrasing (no articles, 'explicit continuation') costs a little readability but nothing is redundant.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so return-value shape need not be described, and annotations cover the safety profile. Still missing for a 4-parameter, 0%-coverage reader: the meaning of task_id, the offset/limit contract, and any disambiguation from sibling readers. Adequate but with clear gaps.

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

Parameters2/5

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

Schema description coverage is 0%, so the description must carry parameter meaning, and it only partially does: 'byte offsets' hints at offset and 'continuation' hints at limit, but neither is explained and task_id is entirely unaddressed. An agent cannot tell from this text whether offset is in bytes or characters, what the limit unit is, or what a task_id is required for.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: reading bytes as UTF-8 text, with mentions of offsets, content hash and continuation. It is clear what the tool does, but nothing distinguishes it from similarly named siblings such as resource_file_read or artifact_preview, so an agent must guess which reader to pick.

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 clause 'Binary files use artifact paths' is a genuine routing hint for the binary case, which is the only explicit when-to-use guidance present. There is no statement of when not to use this tool, no prerequisites (e.g. task context), and no named alternative for text reads.

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