ssh-mcp

io.github.gelse由 GitHub 账号 gelse 发布v0.3.0更新于 Oct 24, 2026

MCP gateway for controlled SSH access with per-client auth, command policies, and audit logging.

概览

AI 生成的概览

一个集中式 MCP 网关,让 AI 助手以受控方式通过 SSH 访问远程服务器,并提供按客户端授权、命令策略和审计日志。

可以做什么
通过 Streamable HTTP 提供六个 MCP 工具:列出已配置的 SSH 目标、查看某目标允许的命令、在远程服务器上执行命令、测试 SSH 连通性,以及通过 SFTP 下载或上传单个文件。授权、限流、连接池和 JSONL 审计日志都在网关中集中处理,而不是由每个客户端各自管理。配置存放在 JSON 文件中并支持热重载,还可选配 Web 仪表盘和 REST API 来管理配置。
适用场景
当多个 AI 代理或客户端需要访问同一批服务器,而你希望在一处定义每个客户端可执行哪些命令、复用连接并保留审计记录时,适合使用。若需要交互式 shell、目录列表或递归 SFTP 传输,或需要网络层访问控制,则不适合。
运行要求
以本地进程或 Docker 容器运行(镜像 ghcr.io/gelse/ssh-mcp,主机端口 9080 映射到 8080)。需要配置目录(CONFIG_DIR),其中包含 ssh-mcp-config.json 和 secrets.json;需要带凭据或密钥的 SSH 目标列表;需要为客户端生成 API 密钥哈希,并通过 X-API-Key 或 Authorization: Bearer 传入。可选:CONFIG_API_ENABLED 和 CONFIG_API_TOKEN 用于配置 API 与仪表盘,LOG_DIR 用于审计日志。
安装前请注意
该网关保存目标的 SSH 凭据和密钥,并能执行命令和传输文件,因此策略配置错误会带来真实的远程访问权限;被允许的命令会以该 SSH 账户的全部权限执行。配置 API 和仪表盘为可选项,由 CONFIG_API_TOKEN 保护;README 指出没有 TLS 终止、没有 OAuth 或 mTLS,审计日志也没有防篡改保护。请将 API 密钥和 secrets 文件视为敏感信息。

安装

在 SourceWeft 中

  1. 打开 控制台中的 ssh-mcp,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

ssh-mcp

A centralized MCP gateway that gives AI agents controlled SSH access over Streamable HTTP.

[License: MIT] [Docker] [MCP] [Security] [M8ven Live Monitored]


What problem does this solve?

Most MCP SSH servers run as local stdio processes — one per client, with no shared state, no centralized authorization, and no audit trail. When multiple AI agents need SSH access, each manages its own SSH keys and runs its own process. This creates:

  • No centralized access control — every client decides what it can run
  • No audit trail — commands are invisible to the ops team
  • SSH key sprawl — keys scattered across every agent machine
  • No rate limiting — a runaway agent can overwhelm a target

ssh-mcp solves this by deploying a single HTTP gateway. All clients connect to it; it connects to your SSH targets. Authorization, rate limiting, connection pooling, and audit logging happen in one place.


Quick Start

Using the pre-built image (recommended)

bash
docker compose pulldocker compose up -d

The image is published at ghcr.io/gelse/ssh-mcp:latest. The compose file maps host port 9080 to container port 8080.

Verify the server is running:

bash
curl http://localhost:9080/health# → {"status": "ok"}

Create a minimal config in config/ssh-mcp-config.json:

json
{  "version": 1,  "ssh_targets": {    "my-server": {      "host": "10.0.1.10",      "username": "deploy"    }  },  "allowed_commands": {    "default": [      {        "targets": ["*"],        "commands": ["hostname", "uptime", "free", "df"]      }    ]  }}

Generate an API key hash and add it to your config or secrets.json (see Configuration).

Build locally instead
bash
make builddocker compose up -d --build

What you can do (tools)

Six MCP tools are available over Streamable HTTP:

ToolDescription
ssh_list_serversList configured SSH targets
ssh_list_allowed_commandsShow allowed commands for a target
ssh_execute_commandExecute a command on a remote server
ssh_check_connectionTest SSH connectivity to a target
ssh_download_fileDownload a file via SFTP
ssh_upload_fileUpload a file via SFTP

Tool Naming Convention

All tools follow the pattern ssh_<verb>_<noun>:

  • ssh_list_servers — list resources
  • ssh_list_allowed_commands — list permissions
  • ssh_execute_command — perform an action
  • ssh_check_connection — verify connectivity
  • ssh_download_file / ssh_upload_file — file transfer

See examples/README.md for usage examples including curl commands and Python client code.


What's configurable

ssh-mcp is configured via JSON files with hot-reload (15 s poll, 2 s debounce). Key areas:

AreaDetails
SSH targetsHost, port, username, key, password
Command policiesBlock patterns, per-key/network allowlists
Connection poolMax connections, idle timeout, concurrency
Rate limitingPer-IP sliding window (default 60 req/min)
LoggingJSONL with rotation, gzip, multiple targets
SFTPSandbox root, path length limits

Full reference: docs/CONFIGURATION.md

FilePurpose
ssh-mcp-config.jsonMain config
config.schema.jsonJSON Schema for validation
secrets.jsonPasswords and API key hashes
MCP_SSH_* env varsOverrides for any setting

Why not just raw SSH / other MCP servers?

ssh-mcp adds a layered authorization chain (9 ordered layers) between every client request and every SSH command. Per-API-key and per-network rules let different agents get different permissions on different servers — without touching the underlying SSH accounts.

Additional protections:

  • Circuit breakers isolate failing targets with exponential backoff
  • Rate limiting prevents runaway agents from overwhelming hosts
  • Structured audit logs trace every command, client, IP, and authorization decision
  • Connection pooling reuses SSH sessions across requests
  • Input sanitization and dangerous-pattern detection block shell injection attempts

Architecture: ARCHITECTURE.md Security model: docs/SECURITY.md


What it is NOT

  • Not an interactive shell — commands are executed individually with structured output
  • Not a file manager — SFTP supports single-file download and upload only (no directory listing or recursive transfer)
  • Not a firewall / network ACL — authorization is command-level, not network-level
  • Does not reduce SSH account privileges — if a command is allowed, the SSH user executes it with whatever privileges that account has

Not yet / known gaps

Fixable with contribution:

  • SFTP is single-file only — no directory listing or recursive transfer
  • No TLS termination — run Traefik or nginx in front
  • No OAuth or mTLS app-layer authentication
  • Rate limiter settings are not hot-reloadable (set at boot)

Architectural:

  • Config API dashboard login sessions are in-memory only — they don't survive restarts and the API is single-instance (config changes themselves persist to the config file normally)
  • No tamper protection for audit logs

Observability

  • Health: GET /health — returns {"status": "ok"}
  • Metrics: GET /metrics — Prometheus exposition format
  • Logging: Structured JSONL with request correlation

Full reference: docs/OBSERVABILITY.md


Config API & Dashboard

An optional web dashboard for managing configuration without editing JSON files. Enable with CONFIG_API_ENABLED=true.

Full reference: docs/CONFIG-API.md


FAQ

Dashboard returns 401 over HTTP

The session cookie defaults to Secure (HTTPS only). For local HTTP testing, set:

yaml
environment:  - CONFIG_API_SESSION_COOKIE_SECURE=false

Then restart the container.

How do MCP clients connect?

Connect to http://host:9080/mcp using the Streamable HTTP transport. Pass your API key via X-API-Key or Authorization: Bearer header.

How do I generate an API key hash?

bash
docker compose exec mcp-ssh python -c \  "from lib.crypto import hash_api_key; print(hash_api_key('your-key'))"# → pbkdf2:sha256:100000$<salt>$<hash>

Or use the hash utility in the Config API dashboard.

How does hot reload work?

The config file is polled every 15 seconds with a 2-second debounce. Changes to targets, commands, and settings take effect without restart. Rate limiter and log target settings require a restart.

Why was my command denied?

Commands are evaluated through a 9-layer authorization chain. The matched_via field in logs shows which layer denied. See Security Model for the full chain.

How does rate limiting work?

Per-IP sliding window, default 60 requests per 60 seconds. Exceeding the limit returns HTTP 503. Configure via settings.rate_limit in the config file.

Where do logs go?

Logs are written to the /logs volume (mapped from ./logs). The active log file is ssh-mcp.log in JSONL format with optional gzip rotation.

Troubleshooting basics

bash
# Check server healthcurl http://localhost:9080/health
# Validate configmake config-test
# Check logsdocker compose logs mcp-ssh

Documentation

DocumentDescription
ARCHITECTURE.mdSystem design and data flow
docs/SECURITY.mdSecurity model and threat analysis
docs/CONFIGURATION.mdFull config reference
docs/CONFIG-API.mdConfig API & dashboard
docs/OBSERVABILITY.mdHealth, metrics, logging
CONTRIBUTING.mdDevelopment and contribution guide
CHANGELOG.mdRelease history
examples/Config examples and client code

Development

bash
# Unit testsmake test
# Integration tests (builds Docker image)make integrationtest

See CONTRIBUTING.md for the full development guide, coding conventions, and PR workflow.


Roadmap

No public roadmap. See Not yet / known gaps for current limitations and opportunities.


License

MIT

来源:README.md,提交 ec87fab

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v0.3.0最新Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分