Skip to main content
Glama

ssh_file_read

Read-only

Reads text files from a remote server in one call, handling multiple paths at once. Unreadable files are reported individually without blocking others, and binary content can be fetched safely via base64 transport.

Instructions

Reads text files from a server, several of them in one call. A file too large or not text comes back as a named failure rather than a partial file, and one unreadable path costs the others nothing. Real binary should travel over the transport instead of the command channel, which has a size limit. To look for something inside logs, ssh_log_search greps on the server rather than shipping the file here.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesOne path, or a list: ["/etc/hosts", "/etc/resolv.conf"]. An unreadable file costs the list nothing — the others still come back.
sudoNoRead as root, for files the profile user cannot open. Default: false
binaryNoFetch over the transport, not the command channel; answer in base64. The safe way for non-text, implies encoding=base64. Default: false
profileYesMachine name.
encodingNobase64 keeps non-text bytes intact but still goes through the command channel and its size limit. Real binary -> binary below. Default: utf8utf8
Behavior5/5

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

Discloses non-obvious failure behavior: oversized/non-text files produce a named failure instead of a partial file, and unreadable paths do not block the rest. It also reveals the command-channel size limit and transports-vs-command distinction. With only readOnlyHint in annotations, this description carries the behavioral burden well and does not contradict it.

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?

Four sentences, each earning its place: purpose, failure semantics, binary routing, and sibling alternative. Front-loaded with the core operation, no filler.

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?

Covers purpose, alternatives, failure modes, and binary handling, which is nearly complete for a read-only file tool. The only notable gap is that with no output schema it does not describe the shape of the returned multi-file result (for example, how file contents are keyed).

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% and the schema already describes path arrays, binary/encoding relationships, and sudo. The description adds operating context, but most parameter meaning is already present in the structured definitions, so it barely moves beyond the baseline.

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?

Opens with a specific verb and resource ('Reads text files from a server, several of them in one call') and distinguishes itself from ssh_log_search by pointing out the log-grep alternative. An agent can tell exactly what this sibling does 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 Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly says to use ssh_log_search when searching inside logs rather than shipping the file here, and says real binary should travel over the transport. These when/not-when rules leave no ambiguity about choosing this tool over alternatives.

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/hypnosis/ssh-mcp-server'

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