Skip to main content
Glama

Read File

read
Read-onlyIdempotent

Read text file contents with head, tail, or specific line ranges. Preview large files using head. Optionally include SHA-256 hash of the full content.

Instructions

Read text file contents. Use head to preview first N lines of large files. For multiple files, use read_many.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesAbsolute path to file or directory.
headNoRead first N lines (preview)
tailNoRead last N lines
startLineNoStart line (1-based, inclusive). Defaults to 1 when endLine is set.
endLineNoEnd line (1-based, inclusive). Defaults to last line when startLine is set.
includeHashNoInclude SHA-256 hash of full file content

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
contentNoContent
truncatedNoTruncated?
resourceUriNoFull content URI
totalLinesNoTotal lines
headNoHead lines
tailNoTail lines
startLineNoStart line
endLineNoEnd line
linesReadNoLines read
hasMoreLinesNoMore lines?
okYes
pathNo
contentHashNoSHA-256 of full file content
Behavior3/5

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

Annotations already indicate readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description adds no additional behavioral context beyond what annotations provide, thus it meets the baseline but does not exceed it.

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 extremely concise at two sentences, front-loading the core purpose. Every sentence provides useful information without redundancy.

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?

Given the presence of an output schema and rich annotations, the description adequately covers the tool's usage. It mentions key alternatives and scenarios, making it complete for the tool's complexity.

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 the schema includes detailed descriptions for each parameter. The tool description does not add any parameter meaning beyond what the schema provides, so 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 states 'Read text file contents' with a clear verb and resource. It distinguishes itself from sibling tools like 'read_many' and suggests using the 'head' parameter for previewing large files, making the purpose specific and differentiated.

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 explicit usage guidance: 'Use `head` to preview first N lines of large files. For multiple files, use `read_many`.' This clearly indicates when to use this tool and alternatives, but does not cover when not to use it.

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/j0hanz/filesystem-mcp'

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