SSH MCP 服务器

一个提供 SSH 功能的模型上下文协议 (MCP) 服务器实现。该服务器允许通过 MCP 协议进行安全的远程访问和执行。

功能特性

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

前提条件

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

安装

1. 克隆仓库：

git clone <repository-url>
cd ssh-server

2. 安装依赖：

npm install

3. 构建项目：

npm run build

使用

配置

服务器使用 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"
    }
}

启动服务器

npm start

服务器将在配置的端口上开始运行（默认设置可以在源代码中修改）。

项目结构

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

依赖项

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

开发

要对项目进行更改：

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

npm run build

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

npm start

许可证

ISC

贡献

1. Fork 仓库
2. 创建您的特性分支
3. 提交您的更改
4. 推送到分支
5. 创建一个新的 Pull Request