SSH Commander

🚀 SSH MCP 服務器

這是一個提供 SSH 功能的 Model Context Protocol (MCP) 服務器實現，藉助 MCP 協議，可實現安全的遠程訪問與操作執行。

🚀 快速開始

本服務器允許通過 MCP 協議進行安全的遠程訪問和執行操作。以下是使用前的準備和啟動步驟。

先決條件

• Node.js（推薦使用 v16 或更高版本）
• npm 或 yarn 包管理器
• 具備 TypeScript 知識用於開發

安裝步驟

1. 克隆倉庫：

git clone <repository-url>
cd ssh-server

2. 安裝依賴項：

npm install

3. 構建項目：

npm run build

啟動服務器

npm start

服務器將在配置好的端口上啟動（默認設置可以在源代碼中修改）。

✨ 主要特性

• 基於 SSH 的 MCP 協議服務器實現。
• 集成 SQLite 數據庫以實現數據持久化。
• 使用 TypeScript 實現，提供類型安全和更好的開發體驗。

💻 使用示例

基礎用法

配置

服務器使用 SQLite 數據庫 (ssh.db) 來存儲 SSH 憑證。數據庫文件將在服務器啟動時自動創建。

工具

服務器提供以下工具：

ssh_exec

通過 SSH 執行命令。 輸入參數：

• host：要連接的主機。（必填）
• command：要執行的命令。（必填）
• username：用於 SSH 連接的用戶名。（必填）
• privateKeyPath：私鑰文件路徑。（必填）

示例用法：

{
    "tool_name": "ssh_exec",
    "arguments": {
        "host": "example.com",
        "command": "ls -l",
        "username": "user",
        "privateKeyPath": "/path/to/private/key"
    }
}

注意：privateKeyPath 必須是有效的私鑰文件路徑。

add_credential

添加新的 SSH 憑證。 輸入參數：

• name：憑證的名稱。（必填）
• host：要連接到的主機。（必填）
• username：用於 SSH 連接的用戶名。（必填）
• privateKeyPath：私鑰文件路徑。（必填）

示例用法：

{
    "tool_name": "add_credential",
    "arguments": {
        "name": "my_credential",
        "host": "example.com",
        "username": "user",
        "privateKeyPath": "/path/to/private/key"
    }
}

注意：privateKeyPath 必須是有效的私鑰文件路徑。

list_credentials

列出所有存儲的 SSH 憑證。 輸入參數：無 示例用法：

{
    "tool_name": "list_credentials",
    "arguments": {}
}

remove_credential

移除一個存儲的 SSH 憑證。 輸入參數：

• name：要移除的憑證名稱。（必填）

示例用法：

{
    "tool_name": "remove_credential",
    "arguments": {
        "name": "my_credential"
    }
}

📚 詳細文檔

項目結構

• src/ - 源代碼目錄
• build/ - 編譯後的 JavaScript 輸出
• node_modules/ - 項目依賴項

依賴項

• @modelcontextprotocol/sdk：MCP 協議實現
• sqlite3：SQLite 數據庫驅動
• typescript：用於 TypeScript 支持的開發依賴

開發

要對項目進行修改：

1. 在 src/ 目錄中進行更改。
2. 重新構建項目：

npm run build

3. 啟動服務器以測試更改：

npm start

📄 許可證

ISC

貢獻

1. 叉倉庫。
2. 創建功能分支。
3. 提交你的更改。
4. 推送到分支機構。
5. 發送拉取請求。