Skip to main content
Glama

ssh_connect

Establish an SSH connection to a remote host and keep it alive for running shell commands and managing devices.

Instructions

Establish an SSH connection to a remote host. Connection is kept alive for subsequent commands.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
hostYesIP address or hostname
portNoSSH port (default: 22)
passwordNoSSH password (optional if using key)
usernameYesSSH username
key_filenameNoPath to SSH private key file (optional if using password)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description must carry behavioral disclosure. It does add value by stating that the connection persists for later commands, which is a meaningful behavioral trait. However, it does not mention authentication behavior, error conditions, timeouts, session reuse, or what happens to existing connections.

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 two short sentences with no filler. The core action is front-loaded, and the second sentence adds the essential lifecycle detail without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

This is a stateful, connection-establishing tool with no annotations and no output schema. The description does not explain how the connection is referenced in later commands, what the return value indicates, or what errors or prerequisites matter. These gaps are significant for an agent expected to use this correctly in a multi-step workflow.

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?

The input schema covers 100% of parameters with meaningful descriptions, so the schema does the heavy lifting. The tool description adds no parameter-level detail beyond what is already in the schema, which is acceptable but not extra value.

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?

The description uses a specific verb and resource ('Establish an SSH connection to a remote host') and clearly identifies the operation. It is distinguishable from siblings like ssh_execute and ssh_disconnect, though it does not name them explicitly.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

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

The phrase 'Connection is kept alive for subsequent commands' implies this tool is for setup before running commands, providing some usage context. However, there is no explicit statement of when to use this over alternatives, when not to use it, or how it relates to siblings like ssh_execute or ssh_list_connections.

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