Skip to main content
Glama

Local Commander

Read file

fs_read
Read-onlyIdempotent

Use this when the user wants to read a text file in an approved project, whole or by line range. Read-only. Needs the sessionId from execution_session_open and a new operationId; each call is metered as one execution. A short result is returned inline within about two seconds; otherwise keep the returned IDs for operation_status and operation_output and do not resend the call.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesFile path relative to the selected project root (or the workspace root without a project target).
endLineNoLast line to return, 1-based (optional)
sessionIdYesexecutionSessionId returned by execution_session_open
startLineNoFirst line to return, 1-based (optional)
deadlineAtNoOptional UTC admission deadline at most 60 seconds ahead (queue start timeout, NOT process execution lifetime)
operationIdYesA new random UUID v4 for this call; reuse it only to retry this same call
idempotencyKeyNoOptional retry key, 8-128 chars of [A-Za-z0-9._:-]; defaults to operationId
efficiencyProfileNoOptional, unverified label of the client's model, recorded as display metadata in the device owner's local activity statistics. Omit when unknown. Never send credentials or conversation content.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior5/5

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

Annotations already cover read-only, idempotent, non-destructive semantics, and the description adds meaningful operational context beyond them: each call is metered as one execution, short results return inline within ~2 seconds, and otherwise the returned IDs feed operation_status/operation_output with an explicit 'do not resend the call' instruction. This materially shapes how an agent should behave.

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?

Three dense sentences with the usage trigger front-loaded and no wasted framing. The async-result sentence is long but each clause (metering, inline vs. deferred, do-not-resend) carries distinct information.

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?

With no output schema, the description correctly explains the return model (inline vs. ID-based retrieval) and the metering/auth prerequisites. It omits guidance on the optional deadlineAt and efficiencyProfile parameters and on error or binary-file cases, leaving minor gaps for an eight-parameter tool.

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%, so the schema already documents all eight parameters including line ranges and the deadline/operationId semantics. The description adds little parameter-level detail beyond restating where sessionId and operationId come from, so the baseline 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?

States a specific verb (read) and resource (text file) plus scope (approved project, whole or by line range), which cleanly separates it from siblings like fs_list, fs_search, fs_write, and fs_replace. An agent can identify the tool's function without opening the schema.

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?

Gives a clear trigger ('when the user wants to read a text file') and prerequisites (sessionId from execution_session_open, a new operationId). It does not explicitly name alternatives such as fs_search or fs_list, nor state exclusions like binary files, so it stops short of full when-not guidance.

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