Skip to main content
Glama
Alierkn
by Alierkn

read_text_file

Read-onlyIdempotent

Read the contents of a text file from the working directory, with an option to limit the number of characters returned.

Instructions

Read a safe text file from a work directory; output is clipped.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
workdirNo.
max_charsNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the tool's safety profile is clear. The description adds the 'output is clipped' behavior, which is valuable. However, it does not explain what 'safe' means (e.g., path traversal restrictions) or how clipping works (controlled by max_chars).

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 one concise sentence that front-loads the action and key constraint. No redundant words or unnecessary information.

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?

Given the tool's simplicity and the presence of an output schema (indicated by context), the description is somewhat adequate. However, it misses explaining the 'safe' restriction and the role of max_chars in clipping. For a tool with 3 parameters and moderate complexity, more detail would improve completeness.

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

Parameters1/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 compensate by explaining parameters. However, the description does not mention any of the three parameters (path, workdir, max_chars), their roles, or defaults. This is a critical gap.

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 action ('read'), the resource ('safe text file from a work directory'), and a key constraint ('output is clipped'). This distinguishes it from sibling tools like list_files (which lists files) and various write tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives (e.g., list_files for listing, or other file manipulation tools). There is no mention of when not to use it, such as for binary files or files outside the work directory.

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/Alierkn/gromacs-mcp'

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