Skip to main content
Glama
ks6573
by ks6573

read_file

Read-onlyIdempotent

Read file contents from a specified path, returning up to 32,000 characters. Useful for viewing config files, logs, scripts, and notes.

Instructions

Read the text contents of a file at the given path. Returns up to max_chars characters (default 16,000, max 32,000). Useful for reading config files, logs, scripts, notes, etc.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesAbsolute or home-relative path to the file (e.g. '~/.zshrc', '/etc/hosts').
max_charsNoMaximum characters to return (1000–32000, default 16000). Truncates with an indicator if exceeded.
Behavior4/5

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

Annotations already declare the tool as read-only, idempotent, and non-destructive, so the bar is lower. The description adds valuable behavioral details about the max_chars limit, default value, and truncation behavior, which go beyond the annotations and help the agent understand output boundaries.

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 two sentences, front-loaded with the core purpose, and every word earns its place. It avoids fluff while including key constraints and use cases.

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

Completeness4/5

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

For a simple read-only tool with two parameters, high schema coverage, and strong annotations, the description covers the essential information: what it reads, what it returns, and size limits. It doesn't explain error cases or binary file handling, but that is not critical for this tool's complexity. 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% for both parameters, so the schema already explains path (absolute/home-relative) and max_chars (range/default). The description merely restates the default and max values without adding new semantics, 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 uses a specific verb ('Read') and resource ('file at the given path'), clearly stating it returns text contents. This distinguishes it well from sibling tools like read_file_lines, tail_file, and write_file, even without naming alternatives.

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 use-case context: 'Useful for reading config files, logs, scripts, notes, etc.' This implies when to use the tool, though it does not explicitly mention alternatives or when not to use it. Given the broad utility of a file reader, this is strong guidance.

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/ks6573/SysControl'

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