🚀 SSH MCP 服务器

这是一个提供 SSH 功能的 Model Context Protocol (MCP) 服务器实现，借助 MCP 协议，可实现安全的远程访问与操作执行。

🚀 快速开始

本服务器允许通过 MCP 协议进行安全的远程访问和执行操作。以下是使用前的准备和启动步骤。

先决条件

• Node.js（推荐使用 v16 或更高版本）
• npm 或 yarn 包管理器
• 具备 TypeScript 知识用于开发

安装步骤

1. 克隆仓库：

git clone <repository-url>
cd ssh-server

2. 安装依赖项：

npm install

3. 构建项目：

npm run build

启动服务器

npm start

服务器将在配置好的端口上启动（默认设置可以在源代码中修改）。

✨ 主要特性

• 基于 SSH 的 MCP 协议服务器实现。
• 集成 SQLite 数据库以实现数据持久化。
• 使用 TypeScript 实现，提供类型安全和更好的开发体验。

💻 使用示例

基础用法

配置

服务器使用 SQLite 数据库 (ssh.db) 来存储 SSH 凭证。数据库文件将在服务器启动时自动创建。

工具

服务器提供以下工具：

ssh_exec

通过 SSH 执行命令。 输入参数：

• host：要连接的主机。（必填）
• command：要执行的命令。（必填）
• username：用于 SSH 连接的用户名。（必填）
• privateKeyPath：私钥文件路径。（必填）

示例用法：

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

注意：privateKeyPath 必须是有效的私钥文件路径。

add_credential

添加新的 SSH 凭证。 输入参数：

• name：凭证的名称。（必填）
• host：要连接到的主机。（必填）
• username：用于 SSH 连接的用户名。（必填）
• privateKeyPath：私钥文件路径。（必填）

示例用法：

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

注意：privateKeyPath 必须是有效的私钥文件路径。

list_credentials

列出所有存储的 SSH 凭证。 输入参数：无 示例用法：

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

remove_credential

移除一个存储的 SSH 凭证。 输入参数：

• name：要移除的凭证名称。（必填）

示例用法：

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

📚 详细文档

项目结构

• src/ - 源代码目录
• build/ - 编译后的 JavaScript 输出
• node_modules/ - 项目依赖项

依赖项

• @modelcontextprotocol/sdk：MCP 协议实现
• sqlite3：SQLite 数据库驱动
• typescript：用于 TypeScript 支持的开发依赖

开发

要对项目进行修改：

1. 在 src/ 目录中进行更改。
2. 重新构建项目：

npm run build

3. 启动服务器以测试更改：

npm start

📄 许可证

ISC

贡献

1. 叉仓库。
2. 创建功能分支。
3. 提交你的更改。
4. 推送到分支机构。
5. 发送拉取请求。