Ssh MCP Server

🚀 SSH-MCP-Server Documentation

ssh-mcp-server is a bridge tool that allows AI assistants and other applications supporting the MCP protocol to remotely execute SSH commands through a standardized interface. This enables AI assistants to securely operate remote servers, execute commands, and obtain results without directly exposing SSH credentials.

🚀 Quick Start

ssh-mcp-server is a powerful tool that enables AI assistants and MCP - protocol - supported applications to interact with remote servers securely. It provides a standardized way to execute SSH commands without exposing sensitive SSH credentials.

✨ Features

• 🔒 Secure Connection: Supports multiple secure SSH connection methods, including password authentication and private key authentication (with passphrase support).
• 🛡️ Command Security Control: Precisely controls the scope of allowed commands through flexible blacklist and whitelist mechanisms to prevent dangerous operations.
• 🔄 Standardized Interface: Complies with the MCP protocol specification, enabling seamless integration with AI assistants that support this protocol.
• 📂 File Transfer: Supports bidirectional file transfer, allowing users to upload local files to the server or download files from the server.
• 🔑 Credential Isolation: SSH credentials are managed locally and never exposed to AI models, enhancing security.
• 🚀 Ready - to - Use: No global installation is required. It can be quickly deployed by directly running with NPX.

📦 Installation

The source code of this project is open - sourced on GitHub and NPM. You can access it through the following links:

• GitHub: https://github.com/classfang/ssh-mcp-server
• NPM: https://www.npmjs.com/package/@fangjunjie/ssh-mcp-server

🛠️ Tool List

💻 Usage Examples

MCP Configuration Examples

Command - line Options

The following are the key parameters that can be specified via the command line:

• --host or -h: The host address of the SSH server (default is localhost).
• --port or -p: The port number of the SSH server (default is 22).
• --user or -u: The username for the SSH connection.
• --password or -P: The password for the SSH connection (not recommended; key - based authentication is preferred).
• --private - key or -k: The path to the private key for SSH authentication.
• --passphrase or -w: The passphrase for the private key.
• --command - whitelist or -w: The whitelist of allowed commands (supports regular expressions).
• --command - blacklist or -b: The blacklist of prohibited commands (supports regular expressions).

Configuration Examples

Configuration Example with Password Authentication

{
  "command": "npx",
  "args": [
    "--host",
    "192.168.1.100",
    "--port",
    "22",
    "--user",
    "root",
    "--password",
    "your_password_here"
  ]
}

Configuration Example with Private Key Authentication

{
  "command": "npx",
  "args": [
    "--host",
    "192.168.1.100",
    "--port",
    "22",
    "--user",
    "root",
    "--private-key",
    "/path/to/private_key.pem",
    "--passphrase",
    "your_passphrase_here"
  ]
}

Configuration Example with Command Whitelist

{
  "command": "npx",
  "args": [
    "--host",
    "192.168.1.100",
    "--port",
    "22",
    "--user",
    "root",
    "--password",
    "your_password_here",
    "--command-whitelist",
    "^ls$|^pwd$"
  ]
}

Configuration Example with Command Blacklist

{
  "command": "npx",
  "args": [
    "--host",
    "192.168.1.100",
    "--port",
    "22",
    "--user",
    "root",
    "--password",
    "your_password_here",
    "--command-blacklist",
    "^rm .*"
  ]
}

⚠️ Important Note

If both the whitelist and blacklist are specified, the system will first check if the command is in the whitelist and then check if it is in the blacklist. The command will only be executed if it passes both checks.