SSH Commander

🚀 SSH MCP Server

An implementation of a Model Context Protocol (MCP) server that provides SSH functionality. This server enables secure remote access and operation execution via the MCP protocol.

✨ Features

• An SSH-based implementation of the MCP protocol server.
• Integration of an SQLite database for data persistence.
• Implemented in TypeScript, offering type safety and a better development experience.

📦 Installation

Prerequisites

• Node.js (version v16 or higher is recommended).
• npm or yarn package manager.
• Knowledge of TypeScript for development.

Steps

1. Clone the repository:

git clone <repository-url>
cd ssh-server

2. Install dependencies:

npm install

3. Build the project:

npm run build

💻 Usage Examples

Configuration

The server uses an SQLite database (ssh.db) to store SSH credentials. The database file will be automatically created when the server starts.

Tools

The server provides the following tools:

ssh_exec

Execute commands via SSH. Input Parameters:

• host: The host to connect to. (Required)
• command: The command to execute. (Required)
• username: The username for the SSH connection. (Required)
• privateKeyPath: The path to the private key file. (Required)

Example Usage:

{
    "tool_name": "ssh_exec",
    "arguments": {
        "host": "example.com",
        "command": "ls -l",
        "username": "user",
        "privateKeyPath": "/path/to/private/key"
    }
}

Note: privateKeyPath must be a valid path to a private key file.

add_credential

Add new SSH credentials. Input Parameters:

• name: The name of the credential. (Required)
• host: The host to connect to. (Required)
• username: The username for the SSH connection. (Required)
• privateKeyPath: The path to the private key file. (Required)

Example Usage:

{
    "tool_name": "add_credential",
    "arguments": {
        "name": "my_credential",
        "host": "example.com",
        "username": "user",
        "privateKeyPath": "/path/to/private/key"
    }
}

Note: privateKeyPath must be a valid path to a private key file.

list_credentials

List all stored SSH credentials. Input Parameters:

• None

Example Usage:

{
    "tool_name": "list_credentials",
    "arguments": {}
}

remove_credential

Remove a stored SSH credential. Input Parameters:

• name: The name of the credential to remove. (Required)

Example Usage:

{
    "tool_name": "remove_credential",
    "arguments": {
        "name": "my_credential"
    }
}

Start the Server

npm start

The server will start on the configured port (the default settings can be modified in the source code).

📚 Documentation

Project Structure

• src/: Source code directory.
• build/: Compiled JavaScript output.
• node_modules/: Project dependencies.

Dependencies

• @modelcontextprotocol/sdk: MCP protocol implementation.
• sqlite3: SQLite database driver.
• typescript: Development dependency for TypeScript support.

Development

To make changes to the project:

1. Make changes in the src/ directory.
2. Rebuild the project:

npm run build

3. Start the server to test the changes:

npm start

📄 License

ISC

👥 Contribution

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Push to the branch.
5. Send a pull request.