Skip to main content
Glama

Read file

read_file
Read-only

Read a file (text, or base64 for binary)

Input Schema

NameRequiredDescriptionDefault
pathYes
encodingNo
project_idNoProject id (or use session from use_project)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.3/5.0
Behavior3/5

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

The annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The parenthetical adds one genuinely behavioral note: binary content is returned base64-encoded. The description still says nothing about file-size limits, behavior when the path is missing, or how project scoping affects the read.

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?

It is a single short sentence with the core action front-loaded, and there is no filler. Nothing can be trimmed without losing 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?

For a simple read tool with strong annotations and no output schema, the description is minimally adequate. An agent still lacks two things: how project_id interacts with path resolution, and what the return value looks like, namely a content string with a specified encoding.

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 low (33%): only project_id is described in the schema, while path and the encoding enum are bare. The parenthetical partially explains encoding ('text, or base64 for binary'), but path semantics (absolute versus project-relative) remain undocumented in both places.

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 states a specific verb and resource: 'Read a file'. It does not distinguish from the nearby list_files, glob_files, or search_files, but the intent is unambiguous. This is clear enough that an agent can select it, but it offers no explicit differentiation from its siblings.

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 gives no guidance on when to use this tool versus alternatives such as list_files or glob_files, and it states no prerequisites. The parenthetical about text versus binary is the only hint about usage context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources