Ssh Connect MCP Server

🚀 SSH Connection to MCP Server

This project contains code entirely generated by AI.

An MCP server for SSH connection and file operations.

🚀 Quick Start

This is an MCP server designed for SSH connections and file operations. All the code in this project is created by generative AI.

✨ Features

Tools

The server implements several SSH-related tools:

• connect: Connect to an SSH server

  • Optional parameters: host, port, username, password, key_path, key_passphrase
  • Returns the connection status

• disconnect: Disconnect from the SSH server

  • No parameters required
  • Returns the disconnection status

• execute: Execute a command on the SSH server

  • Required parameter: command (string)
  • Optional parameter: timeout (integer, in seconds, default is 60)
  • Returns the command output (stdout and stderr) and the exit status

• upload: Upload a file to the SSH server

  • Required parameters: local_path, remote_path
  • Returns the upload status

• download: Download a file from the SSH server

  • Required parameters: remote_path, local_path
  • Returns the download status

• list_files: List files on the SSH server

  • Required parameter: path
  • Returns a file list including type and size information

📦 Installation

Automatic Installation

Two Python scripts are provided for automatic installation of the SSH MCP server:

1. For Cline:

./install_ssh_mcp.py

2. For Claude Desktop:

./install_ssh_mcp_claude.py

These scripts will:

1. Detect the location of the configuration file.
2. Prompt for SSH connection parameters.
3. Update the SSH MCP server configuration in the configuration file.

Manual Installation

On Claude Desktop

An example Claude Desktop configuration file claude-desktop-config-example.json is provided to show how to configure the SSH MCP server in Claude Desktop.

To install the SSH MCP server on Claude Desktop:

1. Locate your Claude Desktop configuration file:

   • On macOS: ~/Library/Application\ 支持/Claude/claude_desktop_config.json
   • On Windows: %APPDATA%/Claude/claude_desktop_config.json

2. Add the SSH MCP server configuration to the mcpServers object:

{
  "mcpServers": {
    "ssh-connect": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/ssh-connect",
        "run",
        "ssh-connect"
      ],
      "env": {
        "SSH_HOST": "example.com",
        "SSH_PORT": "22",
        "SSH_USERNAME": "username",
        "SSH_PASSWORD": "password",
        "SSH_KEY_PATH": "/path/to/private_key",
        "SSH_KEY_PASSPHRASE": "key_passphrase"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

3. Restart Claude Desktop to apply the changes.

⚠️ Important Note

Please replace the placeholder values with your actual SSH connection information.

📚 Documentation

Building and Publishing

To prepare the distribution package:

1. Synchronize dependencies and update the lock file:

uv sync

2. Build the package release version:

uv build

This will create source code and wheel files in the dist/ directory.

3. Publish to PyPI:

uv publish

⚠️ Important Note

You need to set your PyPI credentials via environment variables or command-line flags:

• Token: --token or UV_PUBLISH_TOKEN
• Or username/password: --username/UV_PUBLISH_USERNAME and --password/UV_PUBLISH_PASSWORD

Testing

A test script is provided in the tests directory to verify the proper functioning of the SSH MCP server:

python tests/test_ssh_connect.py

This test script uses unittest and mocking to test the basic functions of the SSH MCP server without actually connecting to an SSH server.

Debugging

Since the MCP server runs through standard input and output, debugging can be challenging. For the best debugging experience, we highly recommend using MCP Inspector.

You can start the MCP Inspector with the following command:

npx @modelcontextprotocol/inspector uv --directory /path/to/ssh-connect run ssh-connect

After starting, the Inspector will display a URL that you can access in your browser to start debugging.