SSH MCP Server

SSH MCP Server

site icon
2025.04.13 2
JavaScriptSSH 服务器远程访问命令执行开发效率
SSH MCP Server 是一个基于 Model Context Protocol (MCP) 的 SSH 服务器实现,提供安全的远程访问和执行能力。它通过 MCP 协议实现 SSH 功能,并集成了 SQLite 数据库用于数据持久化,采用 TypeScript 实现以确保类型安全和更好的开发体验。
View on GitHub

Overview

基本能力

产品定位

SSH MCP Server 是一个基于 MCP 协议的 SSH 服务器,旨在提供安全的远程访问和命令执行能力。

核心功能

  • SSH 服务器实现,支持通过 MCP 协议进行远程访问和命令执行。
  • SQLite 数据库集成,用于持久化存储 SSH 凭证。
  • TypeScript 实现,提供类型安全和更好的开发体验。

适用场景

  • 需要安全远程访问和命令执行的场景。
  • 需要管理多个 SSH 凭证的场景。
  • 开发人员需要集成 SSH 功能到现有系统中的场景。

工具列表

  1. ssh_exec: 通过 SSH 执行命令。
  2. 参数:host(目标主机)、command(执行的命令)、username(用户名)、privateKeyPath(私钥路径)。
  3. add_credential: 添加新的 SSH 凭证。
  4. 参数:name(凭证名称)、host(目标主机)、username(用户名)、privateKeyPath(私钥路径)。
  5. list_credentials: 列出所有存储的 SSH 凭证。
  6. 无参数。
  7. remove_credential: 删除存储的 SSH 凭证。
  8. 参数:name(凭证名称)。

常见问题解答

  • 私钥路径无效:确保 privateKeyPath 参数指向有效的私钥文件。
  • 数据库文件创建失败:确保服务器有权限在启动时创建 ssh.db 文件。

使用教程

使用依赖

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

安装教程

  1. 克隆仓库: bash git clone <repository-url> cd ssh-server
  2. 安装依赖: bash npm install
  3. 构建项目: bash npm run build

调试方式

  1. 启动服务器: bash npm start
  2. 服务器将在配置的端口上运行(默认设置可在源代码中修改)。

开发

  1. src/ 目录中进行更改。
  2. 重新构建项目: bash npm run build
  3. 启动服务器以测试更改: bash npm start

许可证

该项目遵循 ISC 开源许可条款。