ssh-mcp 1.4.0 → 1.5.0

package/README.md

@@ -44,11 +44,13 @@
 - `exec`: Execute a shell command on the remote server
   - **Parameters:**
     - `command` (required): Shell command to execute on the remote SSH server
+    - `description` (optional): Optional description of what this command will do (appended as a comment)
   - **Timeout Configuration:**
 
 - `sudo-exec`: Execute a shell command with sudo elevation
   - **Parameters:**
     - `command` (required): Shell command to execute as root using sudo
+    - `description` (optional): Optional description of what this command will do (appended as a comment)
   - **Notes:**
     - Requires `--sudoPassword` to be set for password-protected sudo
     - Can be disabled by passing the `--disableSudo` flag at startup if sudo access is not needed or not available

package/build/index.js

@@ -302,7 +302,7 @@ export class SSHConnectionManager {
 let connectionManager = null;
 const server = new McpServer({
     name: 'SSH MCP Server',
-    version: '1.4.0',
+    version: '1.5.0',
     capabilities: {
         resources: {},
         tools: {},
@@ -310,7 +310,8 @@ const server = new McpServer({
 });
 server.tool("exec", "Execute a shell command on the remote SSH server and return the output.", {
     command: z.string().describe("Shell command to execute on the remote SSH server"),
-}, async ({ command }) => {
+    description: z.string().optional().describe("Optional description of what this command will do"),
+}, async ({ command, description }) => {
     // Sanitize command input
     const sanitizedCommand = sanitizeCommand(command);
     try {
@@ -354,7 +355,11 @@ server.tool("exec", "Execute a shell command on the remote SSH server and return
                 // Log but don't fail; fall back to non-elevated execution if elevation times out
             }
         }
-        const result = await execSshCommandWithConnection(connectionManager, sanitizedCommand);
+        // Append description as comment if provided
+        const commandWithDescription = description
+            ? `${sanitizedCommand} # ${description.replace(/#/g, '\\#')}`
+            : sanitizedCommand;
+        const result = await execSshCommandWithConnection(connectionManager, commandWithDescription);
         return result;
     }
     catch (err) {
@@ -368,7 +373,8 @@ server.tool("exec", "Execute a shell command on the remote SSH server and return
 if (!DISABLE_SUDO) {
     server.tool("sudo-exec", "Execute a shell command on the remote SSH server using sudo. Will use sudo password if provided, otherwise assumes passwordless sudo.", {
         command: z.string().describe("Shell command to execute with sudo on the remote SSH server"),
-    }, async ({ command }) => {
+        description: z.string().optional().describe("Optional description of what this command will do"),
+    }, async ({ command, description }) => {
         const sanitizedCommand = sanitizeCommand(command);
         try {
             if (!connectionManager) {
@@ -409,15 +415,19 @@ if (!DISABLE_SUDO) {
             }
             let wrapped;
             const sudoPassword = connectionManager.getSudoPassword();
+            // Append description as comment if provided
+            const commandWithDescription = description
+                ? `${sanitizedCommand} # ${description.replace(/#/g, '\\#')}`
+                : sanitizedCommand;
             if (!sudoPassword) {
                 // No password provided, use -n to fail if sudo requires a password
-                wrapped = `sudo -n sh -c '${sanitizedCommand.replace(/'/g, "'\\''")}'`;
+                wrapped = `sudo -n sh -c '${commandWithDescription.replace(/'/g, "'\\''")}'`;
             }
             else {
                 // Password provided — pipe it into sudo using printf. This avoids complex
                 // PTY/stdin handling on the SSH channel and is simpler and more reliable.
                 const pwdEscaped = sudoPassword.replace(/'/g, "'\\''");
-                wrapped = `printf '%s\\n' '${pwdEscaped}' | sudo -p "" -S sh -c '${sanitizedCommand.replace(/'/g, "'\\''")}'`;
+                wrapped = `printf '%s\\n' '${pwdEscaped}' | sudo -p "" -S sh -c '${commandWithDescription.replace(/'/g, "'\\''")}'`;
             }
             return await execSshCommandWithConnection(connectionManager, wrapped);
         }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ssh-mcp",
   "license": "MIT",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "MCP server exposing SSH control for Linux and Windows systems via Model Context Protocol.",
   "type": "module",
   "bin": {