SSHX MCP Server

English Document | 中文文档

SSHX MCP Server is a local Model Context Protocol (MCP) server that exposes SSH control for Linux and Windows systems — with exec, sudo-exec, upload and download tools.

Contents

• Quick Start
• Features
• Installation
• Client Setup
• Testing
• Disclaimer
• Support

Quick Start

• Install SSH MCP Server
• Configure SSH MCP Server
• Set up your MCP Client (e.g. Claude Desktop, Cursor, etc)
• Execute remote shell commands on your Linux or Windows server via natural language

Features

• MCP-compliant server exposing SSH capabilities
• Execute shell commands on remote Linux and Windows systems
• Secure authentication via password or SSH key
• Built with TypeScript and the official MCP SDK
• Configurable timeout protection with automatic process abortion
• Graceful timeout handling - attempts to kill hanging processes before closing connections

Tools

• exec: Execute a shell command on the remote server

  • Parameters:
    • command (required): Shell command to execute on the remote SSH server
    • description (optional): Optional description of what this command will do (appended as a comment)

• sudo-exec: Execute a shell command with sudo elevation

  • Parameters:
    • command (required): Shell command to execute as root using sudo
    • description (optional): Optional description of what this command will do (appended as a comment)
  • Notes:
    • Requires --sudoPassword to be set for password-protected sudo
    • Can be disabled by passing the --disableSudo flag at startup if sudo access is not needed or not available
    • For persistent root access, consider using --suPassword instead which establishes a root shell
    • Tool will not be available at all if server is started with --disableSudo

• upload: Upload a local file to the remote SSH server

  • Parameters:
    • localPath (required): Absolute path to the local file to upload
    • remotePath (required): Absolute path on the remote server to write the file to
  • Timeout Configuration:
    • SFTP transfers use a fixed 300000ms (5 minutes) timeout

• download: Download a file from the remote SSH server to the local machine

  • Parameters:

    • remotePath (required): Absolute path to the remote file to download
    • localPath (required): Absolute path on the local machine to save the file to

  • Timeout Configuration:

    • SFTP transfers use a fixed 300000ms (5 minutes) timeout

  • Timeout Configuration:

    • Timeout is configured via command line argument --timeout (in milliseconds)
    • Default timeout: 60000ms (1 minute)
    • When a command times out, the server automatically attempts to abort the running process before closing the connection

  • Max Command Length Configuration:

    • Max command characters are configured via --maxChars
    • Default: 1000
    • No-limit mode: set --maxChars=none or any <= 0 value (e.g. --maxChars=0)

Installation

1. Clone the repository:

   git clone https://github.com/Brinmon/sshx-mcp.git
   cd sshx-mcp

2. Install dependencies:

   npm install

Client Setup

You can configure your IDE or LLM like Cursor, Windsurf, Claude Desktop to use this MCP Server.

Required Parameters:

• host: Hostname or IP of the Linux or Windows server
• user: SSH username

Optional Parameters:

• port: SSH port (default: 22)
• password: SSH password (or use key for key-based auth)
• key: Path to private SSH key
• sudoPassword: Password for sudo elevation (when executing commands with sudo)
• suPassword: Password for su elevation (when you need a persistent root shell)
• timeout: Command execution timeout in milliseconds (default: 60000ms = 1 minute)
• maxChars: Maximum allowed characters for the command input (default: 1000). Use none or 0 to disable the limit.
• disableSudo: Flag to disable the sudo-exec tool completely. Useful when sudo access is not needed or not available.

{
    "mcpServers": {
        "sshx-mcp": {
            "command": "npx",
            "args": [
                "sshx-mcp",
                "-y",
                "--",
                "--host=1.2.3.4",
                "--port=22",
                "--user=root",
                "--password=pass",
                "--key=path/to/key",
                "--timeout=30000",
                "--maxChars=none"
            ]
        }
    }
}

Claude Code

You can add this MCP server to Claude Code using the claude mcp add command. This is the recommended method for Claude Code.

Basic Installation:

claude mcp add --transport stdio sshx-mcp -- npx -y sshx-mcp -- --host=YOUR_HOST --user=YOUR_USER --password=YOUR_PASSWORD

Installation Examples:

With Password Authentication:

claude mcp add --transport stdio sshx-mcp -- npx -y sshx-mcp -- --host=192.168.1.100 --port=22 --user=admin --password=your_password

With SSH Key Authentication:

claude mcp add --transport stdio sshx-mcp -- npx -y sshx-mcp -- --host=example.com --user=root --key=/path/to/private/key

With Custom Timeout and No Character Limit:

claude mcp add --transport stdio sshx-mcp -- npx -y sshx-mcp -- --host=192.168.1.100 --user=admin --password=your_password --timeout=120000 --maxChars=none

With Sudo and Su Support:

claude mcp add --transport stdio sshx-mcp -- npx -y sshx-mcp -- --host=192.168.1.100 --user=admin --password=your_password --sudoPassword=sudo_pass --suPassword=root_pass

Installation Scopes:

You can specify the scope when adding the server:

• Local scope (default): For personal use in the current project

  claude mcp add --transport stdio sshx-mcp --scope local -- npx -y sshx-mcp -- --host=YOUR_HOST --user=YOUR_USER --password=YOUR_PASSWORD

• Project scope: Share with your team via .mcp.json file

  claude mcp add --transport stdio sshx-mcp --scope project -- npx -y sshx-mcp -- --host=YOUR_HOST --user=YOUR_USER --password=YOUR_PASSWORD

• User scope: Available across all your projects

  claude mcp add --transport stdio sshx-mcp --scope user -- npx -y sshx-mcp -- --host=YOUR_HOST --user=YOUR_USER --password=YOUR_PASSWORD

Verify Installation:

After adding the server, restart Claude Code and ask Cascade to execute a command:

"Can you run 'ls -la' on the remote server?"

For more information about MCP in Claude Code, see the official documentation.

Testing

You can use the MCP Inspector for visual debugging of this MCP Server.

npm run inspect

Disclaimer

SSH MCP Server is provided under the MIT License. Use at your own risk. This project is not affiliated with or endorsed by any SSH or MCP provider.

Contributing

We welcome contributions! Please see our Contributing Guidelines for more information.

Code of Conduct

This project follows a Code of Conduct to ensure a welcoming environment for everyone.

Support

If you find SSH MCP Server helpful, consider starring the repository or contributing! Pull requests and feedback are welcome.