Skip to main content
Glama

read

Read-only

View a text file from the server root and display its contents with line numbers. Supports starting at a specific offset and limiting output to a set number of lines.

Instructions

Read a text file and return its contents with cat-style line numbers.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesFile path relative to the server root
limitNoMaximum number of lines to return
offsetNo0-indexed starting line number

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

Annotations already include readOnlyHint=true, so the safety profile is known. The description adds meaningful behavioral detail about the output format (cat-style line numbers), which goes beyond the annotation. No contradictions exist.

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 a single sentence that is front-loaded with the primary action and includes a specific output detail. Every word earns its place with no waste.

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?

Even though the tool has parameters and an output schema, the description covers the essential purpose and behavior. With an output schema present, the description need not explain return values. The tool is simple and the description is sufficient.

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%, with all three parameters documented in the schema. The description does not add any additional semantics about parameters, so the baseline score of 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?

The description clearly states the verb 'Read' and resource 'text file', and specifies the output format as 'cat-style line numbers'. This distinguishes it from sibling tools like grep (search), find (locate files), ls (list), and write/edit (modify files).

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 makes it clear that the tool is for reading text file contents. It does not explicitly mention when not to use it or point to alternatives, but the specificity of the action ('Read a text file') provides clear context for when this tool is appropriate.

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/garland3/basic-fns-mcp'

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