Add ssh MCP

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

Author: mudler

README.md

@@ -322,6 +322,101 @@ mcp:
     }
 ```
 
+### 🔐 SSH Server
+
+An SSH server that allows AI models to connect to remote SSH hosts and execute shell scripts.
+
+**Features:**
+- Connect to remote SSH hosts
+- Execute shell scripts on remote hosts
+- Support for password and key-based authentication
+- Configurable remote shell command (default: `sh -c`)
+- Separate stdout and stderr capture
+- Exit code reporting
+- Configurable timeout (default: 30 seconds)
+- JSON schema validation for inputs/outputs
+
+**Tool:**
+- `execute_script` - Execute a shell script on a remote SSH host and return the output, exit code, and any errors
+
+**Configuration:**
+- `SSH_HOST` - Default SSH host (can be overridden per request)
+- `SSH_PORT` - Default SSH port (default: 22)
+- `SSH_USER` - Default SSH username (can be overridden per request)
+- `SSH_PASSWORD` - Default SSH password (can be overridden per request, or use SSH_KEY_PATH)
+- `SSH_KEY_PATH` - Path to SSH private key file (alternative to password authentication)
+- `SSH_KEY_PASSPHRASE` - Passphrase for encrypted SSH private key (if needed)
+- `SSH_SHELL_CMD` - Remote shell command to use (default: `sh -c`)
+
+**Input Format:**
+```json
+{
+  "host": "example.com",
+  "port": 22,
+  "user": "username",
+  "password": "password",
+  "script": "ls -la /tmp",
+  "timeout": 30
+}
+```
+
+Or using key-based authentication:
+```json
+{
+  "host": "example.com",
+  "user": "username",
+  "key_path": "/path/to/private/key",
+  "script": "ls -la /tmp",
+  "timeout": 30
+}
+```
+
+**Output Format:**
+```json
+{
+  "host": "example.com",
+  "script": "ls -la /tmp",
+  "stdout": "total 1234\ndrwxrwxrwt...",
+  "stderr": "",
+  "exit_code": 0,
+  "success": true,
+  "error": ""
+}
+```
+
+**Docker Image:**
+```bash
+docker run -e SSH_HOST=example.com -e SSH_USER=user -e SSH_PASSWORD=pass ghcr.io/mudler/mcps/ssh:latest
+```
+
+Or with key-based authentication:
+```bash
+docker run -e SSH_HOST=example.com -e SSH_USER=user -e SSH_KEY_PATH=/path/to/key -v /host/keys:/path/to/key ghcr.io/mudler/mcps/ssh:latest
+```
+
+**LocalAI configuration ( to add to the model config):**
+```yaml
+mcp:
+  stdio: |
+    {
+      "mcpServers": {
+        "ssh": {
+          "command": "docker",
+          "env": {
+            "SSH_HOST": "example.com",
+            "SSH_USER": "username",
+            "SSH_PASSWORD": "password",
+            "SSH_SHELL_CMD": "bash -c"
+          },
+          "args": [
+            "run", "-i", "--rm",
+            "ghcr.io/mudler/mcps/ssh:master"
+          ]
+        }
+      }
+    }
+```
+
 ### 🔧 Script Runner Server
 
 A flexible script and program execution server that allows AI models to run pre-defined scripts and programs as tools. Scripts can be defined inline or via file paths, and programs can be executed directly.
@@ -440,6 +535,7 @@ make MCP_SERVER=duckduckgo build
 make MCP_SERVER=weather build
 make MCP_SERVER=memory build
 make MCP_SERVER=shell build
+make MCP_SERVER=ssh build
 make MCP_SERVER=scripts build
 
 # Run tests and checks
@@ -502,6 +598,9 @@ Docker images are automatically built and pushed to GitHub Container Registry:
 - `ghcr.io/mudler/mcps/shell:latest` - Latest Shell server
 - `ghcr.io/mudler/mcps/shell:v1.0.0` - Tagged versions
 - `ghcr.io/mudler/mcps/shell:master` - Development versions
+- `ghcr.io/mudler/mcps/ssh:latest` - Latest SSH server
+- `ghcr.io/mudler/mcps/ssh:v1.0.0` - Tagged versions
+- `ghcr.io/mudler/mcps/ssh:master` - Development versions
 - `ghcr.io/mudler/mcps/homeassistant:latest` - Latest Home Assistant server
 - `ghcr.io/mudler/mcps/homeassistant:v1.0.0` - Tagged versions
 - `ghcr.io/mudler/mcps/homeassistant:master` - Development versions

go.mod

@@ -17,6 +17,7 @@ require (
 	github.com/pkoukk/tiktoken-go v0.1.6 // indirect
 	github.com/yosida95/uritemplate/v3 v3.0.2 // indirect
 	go.starlark.net v0.0.0-20230302034142-4b1e35fe2254 // indirect
-	golang.org/x/net v0.25.0 // indirect
-	golang.org/x/sys v0.27.0 // indirect
+	golang.org/x/crypto v0.46.0 // indirect
+	golang.org/x/net v0.47.0 // indirect
+	golang.org/x/sys v0.39.0 // indirect
 )

go.sum

@@ -58,6 +58,8 @@ go.starlark.net v0.0.0-20230302034142-4b1e35fe2254 h1:Ss6D3hLXTM0KobyBYEAygXzFfG
 go.starlark.net v0.0.0-20230302034142-4b1e35fe2254/go.mod h1:jxU+3+j+71eXOW14274+SmmuW82qJzl6iZSeqEtTGds=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
+golang.org/x/crypto v0.46.0 h1:cKRW/pmt1pKAfetfu+RCEvjvZkA9RimPbh7bhFjGVBU=
+golang.org/x/crypto v0.46.0/go.mod h1:Evb/oLKmMraqjZ2iQTwDwvCtJkczlDuTmdJXoZVzqU0=
 golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
 golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=
 golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU=
@@ -77,6 +79,7 @@ golang.org/x/net v0.7.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
 golang.org/x/net v0.9.0/go.mod h1:d48xBJpPfHeWQsugry2m+kC02ZBRGRgulfHnEXEuWns=
 golang.org/x/net v0.25.0 h1:d/OCCoBEUq33pjydKrGQhw7IlUPI2Oylr+8qLx49kac=
 golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
+golang.org/x/net v0.47.0/go.mod h1:/jNxtkgq5yWUGYkaZGqo27cfGZ1c5Nen03aYrrKpVRU=
 golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
 golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
@@ -95,6 +98,8 @@ golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.7.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.27.0 h1:wBqf8DvsY9Y/2P8gAfPDEYNuS30J4lPHJxXSb/nJZ+s=
 golang.org/x/sys v0.27.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.39.0 h1:CvCKL8MeisomCi6qNZ+wbb0DN9E5AATixKsvNtMoMFk=
+golang.org/x/sys v0.39.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
 golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
 golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
 golang.org/x/term v0.0.0-20220526004731-065cf7ba2467/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=

shell/main.go

@@ -58,8 +58,15 @@ func ExecuteCommand(ctx context.Context, req *mcp.CallToolRequest, input Execute
 
 	// Parse shell command - support both single command and command with args
 	shellParts := strings.Fields(shellCmd)
+
 	shellExec := shellParts[0]
-	shellArgs := append(shellParts[1:], input.Script)
+	shellArgs := []string{}
+
+	if len(shellParts) > 1 {
+		shellArgs = append(shellParts[1:], input.Script)
+	} else {
+		shellArgs = []string{"-c", input.Script}
+	}
 
 	// Execute script using the configured shell
 	cmd := exec.CommandContext(cmdCtx, shellExec, shellArgs...)
@@ -111,9 +118,14 @@ func main() {
 		Version: "v1.0.0",
 	}, nil)
 
+	configurableName := os.GetEnv("TOOL_NAME")
+	if configurableName == "" {
+		configurableName = "execute_command"
+	}
+
 	// Add tool for executing shell scripts
 	mcp.AddTool(server, &mcp.Tool{
-		Name:        "execute_command",
+		Name:        configurableName,
 		Description: "Execute a shell script and return the output, exit code, and any errors. The shell command can be configured via SHELL_CMD environment variable (default: 'sh')",
 	}, ExecuteCommand)