Ssh

🚀 SSH MCP Server

このプロジェクトは、ローカルで実行される MCP (Model Context Protocol) サービスを提供します。SSH を通じてサーバーを安全にリモート操作し、コマンドの実行とファイルの転送（SFTP）をサポートします。

✨ 主な機能

• 安全な接続：パスワードと秘密鍵の2種類の認証方式をサポート
• コマンド実行：リモートサーバーでコマンドを実行し、出力を取得
• ファイル転送：SFTP を使用したファイルのアップロード、ダウンロード、読み書きをサポート
• ディレクトリ操作：ディレクトリの一覧表示、作成、ファイル/ディレクトリの削除、名前の変更
• 自動接続：環境変数を使用してサーバーを事前に設定し、起動時に自動接続
• セッション管理：複数のセッションを同時にサポートし、セッションの一覧表示と切断が可能
• タイムアウト制御：接続とコマンド実行にタイムアウト設定をサポート

📦 インストール

# プロジェクトをクローン
git clone https://github.com/lilyjem/ssh.git
cd ssh

# 依存関係をインストール
npm install

# プロジェクトをビルド
npm run build

📚 詳細ドキュメント

Cursor での設定

Cursor の設定で MCP 設定（~/.cursor/mcp.json または設定画面を通じて）を見つけ、以下の設定を追加します。

方法1：事前にサーバーを設定（推奨）

環境変数を使用してサーバー情報を事前に設定し、起動時に自動接続します。

{
  "mcpServers": {
    "ssh": {
      "command": "node",
      "args": ["/path/to/ssh/dist/index.js"],
      "env": {
        "SSH_HOST": "your-server-ip",
        "SSH_PORT": "22",
        "SSH_USERNAME": "root",
        "SSH_PASSWORD": "your-password"
      }
    }
  }
}

秘密鍵認証を使用する場合（より安全）：

{
  "mcpServers": {
    "ssh": {
      "command": "node",
      "args": ["/path/to/ssh/dist/index.js"],
      "env": {
        "SSH_HOST": "your-server-ip",
        "SSH_PORT": "22",
        "SSH_USERNAME": "root",
        "SSH_PRIVATE_KEY_PATH": "~/.ssh/id_rsa",
        "SSH_PASSPHRASE": "optional-passphrase"
      }
    }
  }
}

方法2：手動で接続

環境変数を設定せず、使用時に ssh_connect ツールを使用して手動で接続します。

{
  "mcpServers": {
    "ssh": {
      "command": "node",
      "args": ["/path/to/ssh/dist/index.js"]
    }
  }
}

Claude Desktop での設定

Claude Desktop の設定ファイルを編集します。

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "ssh": {
      "command": "node",
      "args": ["/path/to/ssh/dist/index.js"],
      "env": {
        "SSH_HOST": "your-server-ip",
        "SSH_USERNAME": "root",
        "SSH_PASSWORD": "your-password"
      }
    }
  }
}

Claude Code (VS Code 拡張機能) での設定

プロジェクトのルートディレクトリに .mcp.json ファイルを作成します。

{
  "mcpServers": {
    "ssh": {
      "command": "node",
      "args": ["/path/to/ssh/dist/index.js"],
      "env": {
        "SSH_HOST": "your-server-ip",
        "SSH_USERNAME": "root",
        "SSH_PRIVATE_KEY_PATH": "~/.ssh/id_rsa"
      }
    }
  }
}

または、VS Code の設定でグローバルな MCP サーバーを設定することもできます。

Codex CLI での設定

Codex の設定ファイル ~/.codex/config.json を編集します。

{
  "mcpServers": {
    "ssh": {
      "command": "node",
      "args": ["/path/to/ssh/dist/index.js"],
      "env": {
        "SSH_HOST": "your-server-ip",
        "SSH_USERNAME": "root",
        "SSH_PASSWORD": "your-password"
      }
    }
  }
}

npx を使用して実行（クローン不要）

プロジェクトが npm に公開されている場合は、直接 npx を使用できます。

{
  "mcpServers": {
    "ssh": {
      "command": "npx",
      "args": ["ssh"],
      "env": {
        "SSH_HOST": "your-server-ip",
        "SSH_USERNAME": "root",
        "SSH_PASSWORD": "your-password"
      }
    }
  }
}

パスの説明

設定内の /path/to/ssh/dist/index.js は、実際のパスに置き換える必要があります。

• Windows: C:/Users/yourname/projects/ssh/dist/index.js
• macOS/Linux: /home/yourname/projects/ssh/dist/index.js

ヒント：Windows のパスは、正斜線 / または二重バックスラッシュ \\ を使用できます。

🔧 環境変数

*注：パスワード、秘密鍵の内容、秘密鍵のパスのうち少なくとも1つを提供する必要があります。

💻 使用例

事前にサーバーを設定するモード

環境変数を設定した後、サービスを起動すると自動的に接続され、すぐに使用できます。

ユーザー：サーバー上の /var/log ディレクトリを表示
AI：sftp_list(path="/var/log") を呼び出す

ユーザー：nginx の設定を表示
AI：sftp_read(path="/etc/nginx/nginx.conf") を呼び出す

ユーザー：nginx サービスを再起動
AI：ssh_exec(command="systemctl restart nginx") を呼び出す

ユーザー：ローカルの設定ファイルをサーバーにアップロード
AI：sftp_upload(local_path="/local/config/app.conf", remote_path="/etc/app/app.conf") を呼び出す

手動で接続するモード

ユーザー：私のサーバー 192.168.1.100 に接続
AI：ssh_connect(host="192.168.1.100", username="root", password="xxx") を呼び出す
    session_id を返す

ユーザー：ls コマンドを実行
AI：ssh_exec(session_id="xxx", command="ls -la") を呼び出す

ユーザー：接続を切断
AI：ssh_disconnect(session_id="xxx") を呼び出す

🔧 開発

# テストを実行
npm test

# 監視モードでテストを実行
npm run test:watch

# 開発モード（ホットリロード）
npm run dev

# ビルド
npm run build

🔍 制限事項

⚠️ セキュリティに関する注意事項

重要なセキュリティの注意点：

1. 資格情報の保護：パスワードと秘密鍵はメモリ内にのみ保存され、ディスクには永続化されません。
2. ログのセキュリティ：ログにはパスワードと秘密鍵の内容が表示されません。
3. セッションのクリーンアップ：サービスを閉じると、すべてのセッションが自動的にクリーンアップされます。
4. コマンドの制限：コマンドの長さは 1000 文字に制限され、乱用を防ぎます。
5. 出力の制限：出力が 25000 文字を超えると切り捨てられます。
6. 環境変数：パスワードよりも秘密鍵認証を使用することをおすすめします。
7. 設定ファイルのセキュリティ：パスワードを含む設定ファイルをバージョン管理にコミットしないでください。

🔧 技術スタック

• ランタイム：Node.js 18+
• 言語：TypeScript 5
• MCP SDK：@modelcontextprotocol/sdk
• SSH ライブラリ：ssh2
• パラメータ検証：Zod
• テストフレームワーク：Vitest

📄 ライセンス

MIT License - 詳細は LICENSE ファイルを参照してください。