Skip to main content
Glama
Sign In
ssh-mcp

ssh-mcp

by CallumBicknell
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

ssh_read_file

Read the contents of a text file on a remote SSH host. Large files are truncated at a configured size limit; for very large files prefer shell commands with head/tail/grep.

Instructions

Read the contents of a text file on a remote SSH host. Large files are truncated at a configured size limit; for very large files prefer ssh_exec with head/tail/grep.

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": "ssh_read_file"
  }
}

Input Schema

NameRequiredDescriptionDefault
hostYesSSH config alias of the target host
pathYesAbsolute or relative path of the file to read

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.1

TDQS

A4/5.0
Behavior3/5

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

With no annotations, the description carries the full behavioral burden. It usefully discloses truncation at a configured size limit, a non-obvious trait, but omits permission/auth failure behavior, encoding assumptions, and how partial content is signaled.

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?

Two sentences, front-loaded with the core action, and the fallback guidance follows immediately. Every clause earns its place with 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?

For a two-parameter read tool with full schema coverage, the description is nearly complete, covering the action and the truncation caveat. With no output schema, a brief note on the return format (e.g., whether truncation is flagged in the response) would close the remaining gap.

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% for both parameters (host alias, file path), so the schema already carries the semantics. The description adds no syntax, format, or path-resolution detail beyond what the schema provides, making the baseline 3 correct.

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 (contents of a text file on a remote SSH host), including scope (remote host, text file). It implicitly differentiates from ssh_write_file and ssh_exec by naming the exec alternative that handles large-file slicing.

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?

Explicitly routes the agent to ssh_exec with head/tail/grep for very large files, which is clear conditional guidance with a named alternative. It does not, however, address other edge cases (binary files, error paths) that would justify a 5.

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

Deploy Server

Other Tools