Ssh MCP Server K9p

🚀 SSH MCP Server

An SSH server implementing the Model Context Protocol (MCP), offering secure remote access and execution capabilities. This server supports remote SSH connections via the MCP protocol.

🚀 Quick Start

The SSH MCP Server is designed to provide secure remote access and execution features. To get started, you need to meet the prerequisites, install the server, and configure it according to your needs.

✨ Features

• Implementation of an SSH server based on the MCP protocol.
• Integration of an SQLite database for persistent data storage.
• Implemented in TypeScript to ensure type safety and a better development experience.

📦 Installation

Prerequisites

• Node.js (it is recommended to use v16 or a higher version).
• npm or yarn package manager.
• Knowledge of TypeScript 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 a new SSH credential.

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

Delete a stored SSH credential.

Input Parameters:

• name: The name of the credential to delete. (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

• ssh: A library for SSH connections.
• child_process: Used to execute child processes (such as SSH commands).
• fs: Used for file system operations (reading and writing credentials).

Development

To modify the code, follow these steps:

1. Modify the source code files (in the src/ directory).
2. Build the project using the npm script:

npm run build

3. Test the modified functionality.

To contribute to the project, fork the repository and develop on your branch. After completion, submit a Pull Request.

📄 License

[License information]

🤝 Contribution Guidelines

To contribute to this project, follow these steps:

1. Fork the repository.
2. Create a new feature branch in your local copy:

git checkout -b feature/your-feature-name

3. Commit your changes.
4. Push to the remote repository and submit a Pull Request.

We welcome all useful contributions!