Skip to main content
Glama

read_file

Retrieve and display the contents of a documentation or README file by providing its absolute path.

Instructions

Peeks into the contents of a specific documentation or README file.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filePathYesThe absolute path to the file to read.
Behavior2/5

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

With no annotations provided, the description carries the full burden of disclosing behavioral traits. It only implies a read operation ('Peeks into the contents') but does not mention permissions, side effects (e.g., no file locking), or limitations (e.g., file size, encoding).

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?

The description is very concise (single sentence) with no wasted words. However, it could be slightly more informative without sacrificing conciseness.

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?

For a simple tool with one parameter and no output schema, the description is minimally adequate. It does not specify return format or file encoding, but given the low complexity, it covers the essential function.

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 coverage is 100%, so the description adds no additional meaning beyond what the input schema already provides. The parameter 'filePath' is adequately described in the schema, making the description redundant.

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?

The description clearly states the action ('Peeks into the contents') and the target resource ('specific documentation or README file'). However, it does not explicitly distinguish this from sibling tools like 'find_docs' or 'search_docs', though the action of reading a file is distinct enough.

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?

The description provides no guidance on when to use this tool versus alternatives (e.g., when to read vs. search or find documents). It lacks any when-not or prerequisite information.

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/reasvyn/docsgrep'

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