Ssh Connect MCP Server

🚀 SSH 連接 MCP 服務器

這是一個用於 SSH 連接和文件操作的 MCP 服務器，項目中的所有代碼均由生成式 AI 創建。

✨ 主要特性

該服務器實現了幾種與 SSH 相關的工具，具體如下：

• connect：連接到 SSH 服務器。
  • 可選參數：host、port、username、password、key_path、key_passphrase。
  • 返回連接狀態。
• disconnect：斷開與 SSH 服務器的連接。
  • 不需要任何參數。
  • 返回斷開狀態。
• execute：在 SSH 服務器上執行命令。
  • 必填參數：command（字符串）。
  • 可選參數：timeout（整數，秒，默認值為 60）。
  • 返回命令輸出（stdout 和 stderr）和退出狀態。
• upload：將文件上傳到 SSH 服務器。
  • 必填參數：local_path、remote_path。
  • 返回上傳狀態。
• download：從 SSH 服務器下載文件。
  • 必填參數：remote_path、local_path。
  • 返回下載狀態。
• list_files：列出 SSH 服務器上的文件。
  • 必填參數：path。
  • 返回文件列表，包括類型和大小信息。

📦 安裝指南

自動安裝

有兩個 Python 腳本可用於自動安裝 SSH MCP 服務器：

1. 對於 Cline：

./install_ssh_mcp.py

2. 對於 Claude Desktop：

./install_ssh_mcp_claude.py

這些腳本會執行以下操作：

1. 檢測配置文件的位置。
2. 提示輸入 SSH 連接參數。
3. 更新配置文件中的 SSH MCP 服務器配置。

手動安裝

在 Claude Desktop 上

提供了一個示例 Claude Desktop 配置文件 claude-desktop-config-example.json，展示瞭如何在 Claude Desktop 中配置 SSH MCP 服務器。 要將 SSH MCP 服務器安裝到 Claude Desktop，可按以下步驟操作：

1. 找到您的 Claude Desktop 配置文件：
   • 在 macOS 上：~/Library/Application\ 支持/Claude/claude_desktop_config.json
   • 在 Windows 上：%APPDATA%/Claude/claude_desktop_config.json
2. 將 SSH MCP 服務器配置添加到 mcpServers 對象中：

{
  "mcpServers": {
    "ssh-connect": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/ssh-connect",
        "run",
        "ssh-connect"
      ],
      "env": {
        "SSH_HOST": "example.com",
        "SSH_PORT": "22",
        "SSH_USERNAME": "username",
        "SSH_PASSWORD": "password",
        "SSH_KEY_PATH": "/path/to/private_key",
        "SSH_KEY_PASSPHRASE": "key_passphrase"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}

3. 重新啟動 Claude Desktop 以應用更改。

⚠️ 重要提示

請將佔位符值替換為您的實際 SSH 連接信息。

📚 詳細文檔

開發

構建與發佈

要準備分發包，可按以下步驟操作：

1. 同步依賴項並更新鎖定文件：

uv sync

2. 構建包發行版本：

uv build

這將在 dist/ 目錄下創建源代碼和輪文件。 3. 發佈到 PyPI：

uv publish

⚠️ 重要提示

您需要通過環境變量或命令行標誌設置 PyPI 憑據：

• 令牌：--token 或 UV_PUBLISH_TOKEN
• 或者用戶名/密碼：--username/UV_PUBLISH_USERNAME 和 --password/UV_PUBLISH_PASSWORD

測試

在 tests 目錄下提供了一個測試腳本來驗證 SSH MCP 服務器是否正常工作：

python tests/test_ssh_connect.py

該測試腳本使用 unittest 和 mocking 來測試 SSH MCP 服務器的基本功能，而無需實際連接到 SSH 服務器。

調試

由於 MCP 服務器通過標準輸入輸出運行，調試可能會比較困難。為了獲得最佳的調試體驗，我們強烈推薦使用 MCP Inspector。 您可以使用以下命令啟動 MCP Inspector：

npx @modelcontextprotocol/inspector uv --directory /path/to/ssh-connect run ssh-connect

啟動後，Inspector 會顯示一個 URL，您可以在瀏覽器中訪問該 URL 開始調試。