ssh-mcp 1.0.5 → 1.0.7

package/README.md

@@ -1,7 +1,13 @@
 # SSH MCP Server
 
-[![License](https://img.shields.io/github/license/tufantunc/ssh-mcp)](./LICENSE)
 [![NPM Version](https://img.shields.io/npm/v/ssh-mcp)](https://www.npmjs.com/package/ssh-mcp)
+[![Downloads](https://img.shields.io/npm/dm/ssh-mcp)](https://www.npmjs.com/package/ssh-mcp)
+[![Node Version](https://img.shields.io/node/v/ssh-mcp)](https://nodejs.org/)
+[![License](https://img.shields.io/github/license/tufantunc/ssh-mcp)](./LICENSE)
+[![GitHub Stars](https://img.shields.io/github/stars/tufantunc/ssh-mcp?style=social)](https://github.com/tufantunc/ssh-mcp/stargazers)
+[![GitHub Forks](https://img.shields.io/github/forks/tufantunc/ssh-mcp?style=social)](https://github.com/tufantunc/ssh-mcp/forks)
+[![Build Status](https://github.com/tufantunc/ssh-mcp/actions/workflows/ci.yml/badge.svg)](https://github.com/tufantunc/ssh-mcp/actions)
+[![GitHub issues](https://img.shields.io/github/issues/tufantunc/ssh-mcp)](https://github.com/tufantunc/ssh-mcp/issues)
 
 **SSH MCP Server** is a local Model Context Protocol (MCP) server that exposes SSH control for Linux and Windows systems, enabling LLMs and other MCP clients to execute shell commands securely via SSH.
 
@@ -28,10 +34,18 @@
 - Execute shell commands on remote Linux and Windows systems
 - Secure authentication via password or SSH key
 - Built with TypeScript and the official MCP SDK
+- **Configurable timeout protection** with automatic process abortion
+- **Graceful timeout handling** - attempts to kill hanging processes before closing connections
 
 ### Tools
 
 - `exec`: Execute a shell command on the remote server
+  - **Parameters:**
+    - `command` (required): Shell command to execute on the remote SSH server
+  - **Timeout Configuration:**
+    - Timeout is configured via command line argument `--timeout` (in milliseconds)
+    - Default timeout: 60000ms (1 minute)
+    - When a command times out, the server automatically attempts to abort the running process before closing the connection
 
 ## Installation
 
@@ -48,11 +62,16 @@
 ## Client Setup
 
 You can configure Claude Desktop to use this MCP Server.
-   - `host`: Hostname or IP of the Linux or Windows server
-   - `port`: SSH port (default: 22)
-   - `user`: SSH username
-   - `password`: SSH password (or use `key` for key-based auth) (optional)
-   - `key`: Path to private SSH key (optional)
+
+**Required Parameters:**
+- `host`: Hostname or IP of the Linux or Windows server
+- `user`: SSH username
+
+**Optional Parameters:**
+- `port`: SSH port (default: 22)
+- `password`: SSH password (or use `key` for key-based auth)
+- `key`: Path to private SSH key
+- `timeout`: Command execution timeout in milliseconds (default: 60000ms = 1 minute)
 
 
 ```commandline
@@ -68,7 +87,8 @@ You can configure Claude Desktop to use this MCP Server.
                 "--port=22",
                 "--user=root",
                 "--password=pass",
-                "--key=path/to/key"
+                "--key=path/to/key",
+                "--timeout=30000"
             ]
         }
     }
@@ -87,6 +107,14 @@ npm run inspect
 
 SSH MCP Server is provided under the [MIT License](./LICENSE). Use at your own risk. This project is not affiliated with or endorsed by any SSH or MCP provider.
 
+## Contributing
+
+We welcome contributions! Please see our [Contributing Guidelines](./CONTRIBUTING.md) for more information.
+
+## Code of Conduct
+
+This project follows a [Code of Conduct](./CODE_OF_CONDUCT.md) to ensure a welcoming environment for everyone.
+
 ## Support
 
 If you find SSH MCP Server helpful, consider starring the repository or contributing! Pull requests and feedback are welcome. 

package/build/index.js

@@ -4,7 +4,7 @@ import { McpError, ErrorCode } from "@modelcontextprotocol/sdk/types.js";
 import { Client as SSHClient } from 'ssh2';
 import { z } from 'zod';
 import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
-// Example usage: node build/index.js --host=1.2.3.4 --port=22 --user=root --password=pass --key=path/to/key
+// Example usage: node build/index.js --host=1.2.3.4 --port=22 --user=root --password=pass --key=path/to/key --timeout=5000
 function parseArgv() {
     const args = process.argv.slice(2);
     const config = {};
@@ -22,6 +22,7 @@ const PORT = argvConfig.port ? parseInt(argvConfig.port) : 22;
 const USER = argvConfig.user;
 const PASSWORD = argvConfig.password;
 const KEY = argvConfig.key;
+const DEFAULT_TIMEOUT = argvConfig.timeout ? parseInt(argvConfig.timeout) : 60000; // 60 seconds default timeout
 function validateConfig(config) {
     const errors = [];
     if (!config.host)
@@ -37,7 +38,7 @@ function validateConfig(config) {
 validateConfig(argvConfig);
 const server = new McpServer({
     name: 'SSH MCP Server',
-    version: '1.0.5',
+    version: '1.0.7',
     capabilities: {
         resources: {},
         tools: {},
@@ -76,27 +77,61 @@ server.tool("exec", "Execute a shell command on the remote SSH server and return
 async function execSshCommand(sshConfig, command) {
     return new Promise((resolve, reject) => {
         const conn = new SSHClient();
+        let timeoutId;
+        let isResolved = false;
+        // Set up timeout
+        timeoutId = setTimeout(() => {
+            if (!isResolved) {
+                isResolved = true;
+                // Try to abort the running command before closing connection
+                const abortTimeout = setTimeout(() => {
+                    // If abort command itself times out, force close connection
+                    conn.end();
+                }, 5000); // 5 second timeout for abort command
+                conn.exec('timeout 3s pkill -f "' + command + '" 2>/dev/null || true', (err, abortStream) => {
+                    if (abortStream) {
+                        abortStream.on('close', () => {
+                            clearTimeout(abortTimeout);
+                            conn.end();
+                        });
+                    }
+                    else {
+                        clearTimeout(abortTimeout);
+                        conn.end();
+                    }
+                });
+                reject(new McpError(ErrorCode.InternalError, `Command execution timed out after ${DEFAULT_TIMEOUT}ms`));
+            }
+        }, DEFAULT_TIMEOUT);
         conn.on('ready', () => {
             conn.exec(command, (err, stream) => {
                 if (err) {
-                    reject(new McpError(ErrorCode.InternalError, `SSH exec error: ${err.message}`));
+                    if (!isResolved) {
+                        isResolved = true;
+                        clearTimeout(timeoutId);
+                        reject(new McpError(ErrorCode.InternalError, `SSH exec error: ${err.message}`));
+                    }
                     conn.end();
                     return;
                 }
                 let stdout = '';
                 let stderr = '';
                 stream.on('close', (code, signal) => {
-                    conn.end();
-                    if (stderr) {
-                        reject(new McpError(ErrorCode.InternalError, `Error (code ${code}):\n${stderr}`));
-                    }
-                    else {
-                        resolve({
-                            content: [{
-                                    type: 'text',
-                                    text: stdout,
-                                }],
-                        });
+                    if (!isResolved) {
+                        isResolved = true;
+                        clearTimeout(timeoutId);
+                        conn.end();
+                        if (stderr) {
+                            reject(new McpError(ErrorCode.InternalError, `Error (code ${code}):\n${stderr}`));
+                        }
+                        else {
+                            resolve({
+                                content: [{
+                                        type: 'text',
+                                        text: stdout,
+                                    }],
+                            });
+                        }
                     }
                 });
                 stream.on('data', (data) => {
@@ -108,7 +143,11 @@ async function execSshCommand(sshConfig, command) {
             });
         });
         conn.on('error', (err) => {
-            reject(new McpError(ErrorCode.InternalError, `SSH connection error: ${err.message}`));
+            if (!isResolved) {
+                isResolved = true;
+                clearTimeout(timeoutId);
+                reject(new McpError(ErrorCode.InternalError, `SSH connection error: ${err.message}`));
+            }
         });
         conn.connect(sshConfig);
     });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ssh-mcp",
   "license": "MIT",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "MCP server exposing SSH control for Linux and Windows systems via Model Context Protocol.",
   "type": "module",
   "bin": {
@@ -25,5 +25,29 @@
     "@types/ssh2": "^1.15.5",
     "shx": "^0.4.0",
     "typescript": "^5.4.5"
+  },
+  "homepage": "https://github.com/tufantunc/ssh-mcp#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tufantunc/ssh-mcp.git"
+  },
+  "bugs": {
+    "url": "https://github.com/tufantunc/ssh-mcp/issues"
+  },
+  "keywords": [
+    "ssh",
+    "mcp",
+    "model-context-protocol",
+    "server",
+    "windows",
+    "linux",
+    "automation",
+    "remote",
+    "cli",
+    "typescript"
+  ],
+  "author": "tufantunc",
+  "engines": {
+    "node": ">=18"
   }
 }