Ssh MCP Server K9p

🚀 SSH MCP サーバ

Model Context Protocol (MCP) プロトコルを実装した SSH サーバで、安全なリモートアクセスと実行機能を提供します。このサーバは 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. 変更後の機能をテストします。

プロジェクトに貢献するには、リポジトリをフォークし、自分のブランチで開発を行ってください。完了したら、Pull Request を送信してください。

📄 ライセンス

[ライセンス情報]

貢献ガイド

このプロジェクトに貢献するには、以下の手順に従ってください：

1. リポジトリをフォークします。
2. ローカルコピーで新しい機能ブランチを作成します：

git checkout -b feature/your-feature-name

3. 変更をコミットします。
4. リモートリポジトリにプッシュし、Pull Request を送信します。

すべての有益な貢献を歓迎します！