Skip to main content
Glama

read_file

Read a text file up to 1 MB from a remote host over SSH, using relative paths from the home directory. Use it to inspect configs or logs without opening an interactive shell.

Instructions

Read a text file on a host (up to 1 MB).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "host": "<host>",
      "path": "<path>"
    },
    "name": "read_file"
  }
}

Input Schema

NameRequiredDescriptionDefault
hostYes
pathYesA path on the host; relative paths start at the home directory.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior3/5

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

With no annotations supplied, the description does extra work by disclosing two real behavioral constraints: text-only content and a 1 MB ceiling. It says nothing about permission/access requirements, what happens for a missing or oversized file, or whether content is truncated or an error is returned.

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?

A single short sentence, front-loaded with the operation and immediately followed by the most decision-relevant constraint. No filler and nothing to trim.

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 two-parameter read tool with no output schema and no annotations, the essentials are mostly covered by the size and text-type constraints. The remaining gaps around access prerequisites and failure behavior matter given that siblings like request_access and open_session exist.

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

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is only 50% — path is documented (relative paths resolve to the home directory) but host has no schema description. The description's 'on a host' hints at a remote target but adds no meaning about host identification, format, or path resolution beyond the schema.

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?

States a specific verb and resource ('Read a text file on a host') plus a size bound, which clearly separates it from write_file and list_dir. It stops short of naming an explicit sibling alternative, but the operation is unambiguous.

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?

There is no when-to-use guidance, no mention of prerequisites such as host access or request_access, and no pointer to alternatives for directory listing or binary transfer. The agent must infer that this is the retrieval counterpart to write_file.

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