Skip to main content
Glama

ssh_read_file

Read and return a file's content from a remote server over SSH for explanation, analysis, or review.

Instructions

Read and return the contents of a file on a remote server. Use this when the user asks to explain, analyze, review, or show a file from a server. Requires an active SSH connection.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
maxBytesNoMaximum bytes to read (default: 1048576)
remotePathYesAbsolute path to the file on the remote server
connectionIdYesHost alias from ~/.ssh/config (e.g. "Beta") or an active connection ID
Behavior3/5

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

With no annotations, the description carries the full burden. It discloses the read-only nature implicitly and the active connection requirement, but it doesn't mention potential truncation due to maxBytes, permission errors, or what happens if the file is missing. This is a minimal but not comprehensive disclosure.

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?

The description is extremely concise: two sentences that front-load the purpose and immediately provide usage context. Every word earns its place with no fluff or redundancy.

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?

For a simple 3-parameter read tool with no output schema, the description covers purpose, usage, and a prerequisite. It omits return-format details and error behavior, but given the tool's simplicity and full schema coverage, it is sufficiently complete for an agent to invoke it correctly.

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 baseline is 3. The description adds no additional parameter-level detail beyond what the schema already provides, so no extra credit is warranted.

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?

The description clearly states the tool's function: 'Read and return the contents of a file on a remote server.' It uses a specific verb and resource, and differentiates from siblings by explicitly mentioning use cases like 'explain, analyze, review, or show a file' versus downloading.

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?

It provides explicit guidance with 'Use this when the user asks to explain, analyze, review, or show a file from a server' and notes a prerequisite ('Requires an active SSH connection'). However, it doesn't explicitly mention alternatives or when not to use it, which would earn a 5.

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/mihirbhadak/SSH-MCP'

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