Ssh MCP Server K9p

🚀 SSH MCP 服務器

SSH MCP 服務器是一個實現了 Model Context Protocol (MCP) 協議的 SSH 服務器，它能提供安全的遠程訪問和執行功能，通過 MCP 協議支持遠程 SSH 連接，為用戶帶來便捷、安全的遠程操作體驗。

🚀 快速開始

SSH MCP 服務器通過 MCP 協議實現遠程 SSH 連接，為用戶提供安全的遠程訪問和執行功能。下面為你介紹使用它的基本步驟。

✨ 主要特性

• 基於 MCP 協議的 SSH 服務器實現，保障遠程連接的高效與安全。
• 集成 SQLite 數據庫進行數據持久化存儲，確保數據的穩定保存。
• 使用 TypeScript 實現以確保類型安全和更佳的開發體驗，提升開發效率。

📦 安裝指南

先決條件

• Node.js（建議使用 v16 或更高版本）
• npm 或 yarn 包管理器
• TypeScript 開發知識

安裝步驟

1. 克隆倉庫：

git clone <repository-url>
cd ssh-server

2. 安裝依賴項：

npm install

3. 構建項目：

npm run build

💻 使用示例

配置

服務器使用 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"
    }
}

啟動服務器

npm start

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

📚 詳細文檔

項目結構

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

依賴

• ssh：用於 SSH 連接的庫。
• child_process：用於執行子進程（如 SSH 命令）。
• fs：用於文件系統操作（讀取和寫入憑據）。

開發

要進行代碼修改，請按照以下步驟操作：

1. 修改源代碼文件（在 src/ 目錄中）。
2. 使用 npm 腳本構建項目：

npm run build

3. 測試更改後的功能。

要貢獻到項目，請 fork 倉庫並在您的分支上進行開發。完成後提交一個 Pull Request。

貢獻指南

要為該項目做貢獻，請按照以下步驟操作：

1. Fork 倉庫。
2. 在您的本地副本中創建一個新的功能分支：

git checkout -b feature/your-feature-name

3. 提交您的更改。
4. 推送到遠程倉庫並提交 Pull Request。

我們歡迎所有有用的貢獻！

🔧 技術細節

本項目使用 TypeScript 進行開發，基於 MCP 協議實現 SSH 服務器。通過集成 SQLite 數據庫，實現了數據的持久化存儲。在運行過程中，使用 ssh 庫進行 SSH 連接，child_process 執行子進程（如 SSH 命令），fs 進行文件系統操作（讀取和寫入憑據）。這些技術的結合，使得項目具備了安全、高效的遠程訪問和執行功能。

📄 許可證

[許可證信息]