Skip to main content
Glama
Zw-awa

ssh-session-mcp

by Zw-awa

ssh-session-open

Open a persistent interactive SSH session with PTY support, automatic idle cleanup, and a terminal dashboard view. Maintain state across commands for remote development and infrastructure workflows.

Instructions

Open a persistent interactive SSH PTY session with automatic idle cleanup and a terminal-style dashboard view.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyNoPath to a private SSH key on the local machine
colsNoPTY column count
hostNoSSH host. Falls back to server --host if omitted
portNoSSH port. Falls back to server --port or 22
rowsNoPTY row count
termNoPTY TERM value
userNoSSH username. Falls back to server --user if omitted
deviceNoDevice profile id from ssh-session-mcp.config.json
passwordNoSSH password
viewerModeNoViewer launch mode when autoOpenViewer is enabled
sessionNameNoOptional human-readable alias for the session
startupInputNoRaw text to send immediately after opening the session
idleTimeoutMsNoAuto-close the SSH session after this much inactivity. 0 disables idle cleanup
startupWaitMsNoHow long to wait before capturing the initial dashboard
autoOpenViewerNoAutomatically ensure a local viewer is opened for this session
connectionNameNoLogical connection name for the selected device
dashboardWidthNoRendered dashboard width in columns
dashboardHeightNoRendered dashboard height in rows
includeDashboardNoInclude the rendered dashboard text in the tool response
closedRetentionMsNoHow long to keep a closed session summary/transcript in memory before pruning
startupInputActorNoActor label for startupInput, e.g. codex, claude, user
stripAnsiFromLeftNoStrip ANSI escape sequences from rendered SSH output
dashboardLeftCharsNoHow many recent transcript chars to retain in the rendered viewer
dashboardRightEventsNoHow many recent input/control/lifecycle events to retain for actor markers
viewerSingletonScopeNoHow viewer singleton deduplication is scoped when autoOpenViewer is enabled
Behavior2/5

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

No annotations are provided, so the description must fully disclose behavioral traits. It mentions idle cleanup and a dashboard, but omits important details such as the session lifecycle (needs manual closure), potential viewer side effects, and requirements like SSH keys or passwords. The description is too brief for a complex tool with 25 parameters.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single concise sentence, but for a tool with 25 parameters and many siblings, it is too brief to be fully informative. It is front-loaded but sacrifices necessary detail, making it adequate but not optimal.

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?

Given the tool's complexity (25 parameters, many siblings, no output schema, no annotations), the description is incomplete. It does not explain the session model, how it relates to other session tools, or what the dashboard contains. The agent would need additional context to use it properly.

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 schema has 100% description coverage, so the description adds minimal value beyond stating the overall purpose. It alludes to idleTimeoutMs and dashboard parameters, but does not provide new semantics for individual parameters. A baseline of 3 is appropriate given high schema coverage.

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 it opens a persistent interactive SSH PTY session, with automatic idle cleanup and a dashboard view. This distinguishes it from siblings like ssh-run (one-off commands) and ssh-quick-connect (quick connections) by emphasizing persistence and interactivity.

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 description implies use for persistent interactive sessions but does not explicitly contrast with alternatives like ssh-run or ssh-quick-connect. No when-to-use or when-not-to-use guidance is given, leaving the agent to infer from context.

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/Zw-awa/ssh-session-mcp'

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