Skip to main content
Glama

Read file

file_read
Read-only

Read a UTF-8 file from a specified workspace. Provide the workspace ID and file path to retrieve content, with optional offset and limit for partial access.

Instructions

Read a UTF-8 file inside an open workspace.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workspaceIdYes
pathYes
offsetNo
limitNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYes
contentYes
totalLinesYes
returnedLinesYes
offsetYes
limitedYes
Behavior3/5

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

Annotations already declare readOnlyHint=true, so description's addition of 'UTF-8' and open workspace requirement adds some value but does not cover error handling or behavior with offset/limit.

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?

Single sentence, efficiently worded. Not overly concise to the point of omitting critical context, but could add parameter details without verbosity.

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

Completeness2/5

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

Does not describe return value (expected file content) or behavior when file not found. Output schema exists but is not shown, leaving gaps in understanding.

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?

With 0% schema description coverage, description does not explain any parameter (workspaceId, path, offset, limit), leaving the agent to rely solely on schema definitions.

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?

Description clearly states the action ('Read'), resource ('UTF-8 file'), and constraint ('inside an open workspace'). Distinguishes from sibling tools like file_write or file_edit.

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 explicit guidance on when to use this tool versus alternatives such as search_text or directory_list. Only implies workspace must be open.

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/majiayu000/workspaceguard-mcp'

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