M2m MCP Server Ssh Client

🚀 MCP Server SSH Client

The MCP Server SSH Client is a tool that allows you to connect to an MCP server via SSH. It simplifies the process of SSH connections and provides various configuration options.

🚀 Quick Start

To quickly start using the MCP Server SSH Client, you can install it using the following command:

pip install mcp-server-ssh-client

✨ Features

• Customizable Configuration: You can customize the behavior of the client through various configuration options.
• Multiple Authentication Methods: Support for authentication using default SSH configuration files or custom keys.
• Flexible Logging: Set different log levels according to your needs.

📦 Installation

To install the MCP Server SSH Client and its dependencies, run the following command:

pip install mcp-server-ssh-client

💻 Usage Examples

Basic Usage

Run the following command to start the MCP Server SSH Client:

uvx mcp_server_ssh_client --host <hostname> --port <port>

Advanced Usage

You can customize the client's behavior through the following options:

• --host or -h: Specify the hostname or IP address of the target SSH server.
• --port or -p: Specify the port number of the target SSH server, default is 22.
• --key-file or -k: Specify the path to the private key file for authentication, default is ~/.ssh/id_ed25519.
• --known_hosts or -K: Specify the path to the known hosts file, default is ~/.ssh/known_hosts.
• --config or -c: Specify the path to a custom configuration file.
• --log-level or -l: Set the log level, available values are debug, info, warning, error, critical, default is warning.

Detailed Explanation

Using the Default SSH Configuration File

The MCP Server SSH Client uses the standard SSH configuration file by default:

• Private key file: ~/.ssh/id_ed25519
• Known hosts file: ~/.ssh/known_hosts

Ensure that these files exist and have appropriate permissions (600).

Using Custom Keys

If you have multiple SSH key pairs and want to use a specific key for authentication, you can specify the --key-file option:

uvx mcp_server_ssh_client --host example.com --port 2222 --key-file /path/to/my_key

Configuration File Format

You can create a custom configuration file (e.g., ~/.config/mcpx.json) to specify default values:

{
  "host": "example.com",
  "port": 22,
  "key_file": "~/.ssh/id_ed25519",
  "known_hosts": "~/.ssh/known_hosts",
  "log_level": "warning"
}

📚 Documentation

Security Precautions

• Always enable host key verification in a production environment.
• Use SSH keys with passphrases to enhance security.
• Consider using a dedicated SSH key for MCP connections.
• Set appropriate file permissions (600) to protect your SSH key files.
• Use a dedicated user with limited permissions on the remote server.

Troubleshooting Common Issues

Connection Refused

Error message:

Error running MCP SSH client: [Errno 111] Connection refused

Solution: Check if the hostname and port number are correct, and ensure that the SSH service is running.

Authentication Failed

Error message:

Error running MCP SSH client: Authentication failed

Solution: Check the key file path. Ensure that your public key is installed on the remote server.

Key Verification Failed

Error message:

Error running MCP SSH client: Private key file is invalid or unavailable

Solution: Ensure that the private key file exists and has appropriate permissions (600). Try using chmod 600 ~/.ssh/id_ed25519 to fix the permission issue.

Development Guide

Installing Dependencies

To develop the MCP Server SSH Client, first install the required dependencies:

pip install mcp-server-ssh-client[dev]

Starting Debug Mode

During development or debugging, you can enable the debug log level:

uvx mcp_server_ssh_client --host example.com --port 22 --log-level debug

Contributing to Documentation

If you wish to contribute documentation or code to this project, please refer to the CONTRIBUTING.md file in the GitHub repository.

Thank you for using the MCP Server SSH Client! If you have any questions or suggestions, please feel free to submit an issue or pull request on GitHub.