使用说明
mcp-ssh
用于SSH连接和在远程服务器上执行命令的MCP服务器。
快速启动
- 建立依赖关系:
- npm 安装
-
基于.env.example创建.env并设置连接参数。
-
在开发模式下运行:
- npm运行开发
或者收集并运行:
- npm 运行构建
- npm启动
通过Docker Compose启动
-
基于.env.example创建.env。
-
启动服务:
- docker组成-up-d
该服务在STDIO(MCP)下运行,不需要端口续航。
可用的MCP工具
ssh-connect
创建SSH会话。
参数:
- 主机(字符串,可选)
- 端口(编号,可选)
- 用户名(字符串,可选)
- privateKey(字符串,可选)
- privateKeyPath(字符串,可选)
- 密码(字符串,可选)
- connectTimeoutMs(数字,可选)
返回:会话ID,主机,端口,用户名。
ssh_exec
在现有会话中执行命令。
参数:
- sessionId(字符串)
- 命令(字符串)
- cwd(字符串,可选)
- timeoutMs(数字,可选)
返回:stdout,stderr,exitcode,exitsignal。
ssh断开连接
会议闭幕。
参数:
- sessionId(字符串)
返回:断开连接。
ssh_list_sessions
返回活动会话列表。
主机限制
如果指定了mcpu sshu allowedu hosts,则仅允许连接到列表中的主机。
