ssh-mcp 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Tufan Tunç
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,92 @@
+# 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)
+
+**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.
+
+## Contents
+
+- [Quick Start](#quick-start)
+- [Features](#features)
+- [Installation](#installation)
+- [Client Setup](#client-setup)
+- [Testing](#testing)
+- [Disclaimer](#disclaimer)
+- [Support](#support)
+
+## Quick Start
+
+- [Install](#installation) SSH MCP Server
+- [Configure](#configuration) SSH MCP Server
+- [Set up](#client-setup) your MCP Client (e.g. Claude Desktop, Cursor, etc)
+- Execute remote shell commands on your Linux or Windows server via natural language
+
+## Features
+
+- MCP-compliant server exposing SSH capabilities
+- Execute shell commands on remote Linux and Windows systems
+- Secure authentication via password or SSH key
+- Built with TypeScript and the official MCP SDK
+
+### Tools
+
+- `exec`: Execute a shell command on the remote server
+
+## Installation
+
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/tufantunc/ssh-mcp.git
+   cd ssh-mcp
+   ```
+2. **Install dependencies:**
+   ```bash
+   npm install
+   ```
+
+## 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)
+
+
+```commandline
+{
+    "mcpServers": {
+        "ssh-mcp": {
+            "command": "npx",
+            "args": [
+                "ssh-mcp",
+                "-y",
+                "--",
+                "--host=1.2.3.4",
+                "--port=22",
+                "--user=root",
+                "--password=pass",
+                "--key=path/to/key"
+            ]
+        }
+    }
+}
+```
+
+## Testing
+
+You can use the [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector) for visual debugging of this MCP Server.
+
+```sh
+npm run inspect
+```
+
+## Disclaimer
+
+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.
+
+## Support
+
+If you find SSH MCP Server helpful, consider starring the repository or contributing! Pull requests and feedback are welcome. 

package/build/index.js

@@ -0,0 +1,101 @@
+// This file should be renamed to index.ts for TypeScript support
+import 'dotenv/config';
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+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';
+// Parse SSH config from process.argv
+// Example usage: node build/index.js --host=1.2.3.4 --port=22 --user=root --password=pass --key=path/to/key
+function parseArgv() {
+    const args = process.argv.slice(2);
+    const config = {};
+    for (const arg of args) {
+        const match = arg.match(/^--([^=]+)=(.*)$/);
+        if (match) {
+            config[match[1]] = match[2];
+        }
+    }
+    return config;
+}
+const argvConfig = parseArgv();
+const HOST = argvConfig.host;
+const PORT = argvConfig.port ? parseInt(argvConfig.port) : 22;
+const USER = argvConfig.user;
+const PASSWORD = argvConfig.password;
+const KEY = argvConfig.key;
+const server = new McpServer({
+    name: 'SSH MCP Server',
+    version: '1.0.0',
+    capabilities: {
+        resources: {},
+        tools: {},
+    },
+});
+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 }) => {
+    const sshConfig = {
+        host: HOST,
+        port: PORT,
+        username: USER,
+    };
+    if (PASSWORD) {
+        sshConfig.password = PASSWORD;
+    }
+    else if (KEY) {
+        const fs = await import('fs/promises');
+        sshConfig.privateKey = await fs.readFile(KEY, 'utf8');
+    }
+    const result = await execSshCommand(sshConfig, command);
+    return result;
+});
+async function execSshCommand(sshConfig, command) {
+    return new Promise((resolve, reject) => {
+        const conn = new SSHClient();
+        conn.on('ready', () => {
+            conn.exec(command, (err, stream) => {
+                if (err) {
+                    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,
+                                }],
+                        });
+                    }
+                });
+                stream.on('data', (data) => {
+                    stdout += data.toString();
+                });
+                stream.stderr.on('data', (data) => {
+                    stderr += data.toString();
+                });
+            });
+        });
+        conn.on('error', (err) => {
+            reject(new McpError(ErrorCode.InternalError, `SSH connection error: ${err.message}`));
+        });
+        conn.connect(sshConfig);
+    });
+}
+async function main() {
+    const transport = new StdioServerTransport();
+    await server.connect(transport);
+    console.error("SSH MCP Server running on stdio");
+}
+main().catch((error) => {
+    console.error("Fatal error in main():", error);
+    process.exit(1);
+});

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "ssh-mcp",
+  "version": "1.0.0",
+  "description": "MCP server exposing SSH control for Linux and Windows systems via Model Context Protocol.",
+  "type": "module",
+  "bin": {
+    "ssh-mcp": "build/index.js"
+  },
+  "scripts": {
+    "prepare": "npm run build",
+    "build": "tsc --outDir build",
+    "inspect": "npx @modelcontextprotocol/inspector node build/index.js"
+  },
+  "files": [
+    "build"
+  ],
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.10.2",
+    "dotenv": "^16.3.1",
+    "ssh2": "^1.11.0",
+    "zod": "^3.24.3"
+  },
+  "devDependencies": {
+    "@types/node": "^20.17.31",
+    "@types/ssh2": "^1.15.5",
+    "typescript": "^5.4.5"
+  }
+}