Win Cli MCP Server

🚀 Windows CLI サーバー設定と API ドキュメント

このプロジェクトは、Windows CLI サーバーの設定と API の詳細を提供します。セキュリティやロギング、SSH 接続などの設定を柔軟に行え、RESTful API を通じて各種操作を実行できます。

🚀 クイックスタート

このセクションでは、プロジェクトの基本的な設定と操作方法を説明します。

📦 インストール

このプロジェクトには特にインストール手順はありません。config.json ファイルを適切に設定することで、すぐに使用できます。

📚 ドキュメント

🔧 設定ファイル構造

プロジェクトの核心設定は config.json ファイルに保存されており、以下の主要なセクションがあります。

セキュリティ設定

• security
  • blockedCommands: 危険なコマンドのリスト（デフォルトでは、rm、del、format が含まれます）
  • blockedArguments: 使用禁止の引数リスト（デフォルトでは危険なフラグオプションが含まれます）
  • enableInjectionProtection: コマンドインジェクション防止機能の有効化（デフォルトで有効）
  • restrictWorkingDirectory: コマンドの実行ディレクトリを指定パスに制限するかどうか（デフォルトで有効）
  • commandLengthLimit: コマンドの最大許容長（デフォルト: 2000 文字）
  • commandTimeout: コマンドの最大実行時間（デフォルト: 30 秒）

ログ設定

• logging
  • logCommands: コマンド履歴を記録するかどうか（デフォルトで有効）
  • logPath: ログファイルの保存パス（デフォルト: ./logs/commands.log）

SSH 接続設定

• sshConfig
  • defaultTimeout: デフォルトの接続タイムアウト時間（デフォルト: 10 秒）
  • maxConcurrentSessions: 最大同時 SSH セッション数（デフォルト: 5）
  • connectionConfigs: すべての設定済み SSH 接続情報を保存

🔌 核心 API 関数

コマンド実行

• executeCommand

  • ローカルコマンドを実行します。
  • 入力:
    • command: 実行するコマンド文字列（必須）
    • workingDirectory: オプションの実行ディレクトリ、デフォルトは現在のディレクトリ
  • 出力:
    • 成功時: { success: true, output: String }
    • 失敗時: { success: false, error: String }

• executeSshCommand

  • リモート SSH コマンドを実行します。
  • 入力:
    • connectionId: 接続識別子（必須）
    • command: 実行するコマンド文字列（必須）
  • 出力:
    • 成功時: { success: true, output: String }
    • 失敗時: { success: false, error: String }

接続管理

• addSshConnection

  • 新しい SSH 接続を追加します。
  • 入力:
    • connectionId: 接続識別子（必須）
    • host: ターゲットホストアドレス（必須）
    • port: 接続ポート、デフォルトは 22
    • username: ユーザー名（必須）
    • password: パスワードまたは秘密鍵のパス（オプション、キー認証の使用を推奨）
  • 出力:
    • 成功時: { success: true }
    • 失敗時: { success: false, error: String }

• removeSshConnection

  • 指定された SSH 接続を削除します。
  • 入力:
    • connectionId: 接続識別子（必須）
  • 出力:
    • 成功時: { success: true }
    • 失敗時: { success: false, error: String }

🌐 リソース URI 定義

すべてのリソースは RESTful API インターフェースを通じてアクセスでき、統一されたパスは /api/v1/ です。

• /commands

  • ローカルコマンドの実行を管理します。POST リクエストで新しいコマンドを送信できます。

• /ssh_connections

  • SSH 接続設定を管理します。GET（すべての接続を取得）、POST（新しい接続を追加）、DELETE（指定された接続を削除）操作がサポートされています。

⚠️ セキュリティ注意事項

組み込み保護機能

1. コマンドインジェクション防止: デフォルトでは、悪意のあるコード注入攻撃を防止するための多層フィルタリング機構が有効になっています。
2. ディレクトリ制限: すべてのコマンド実行は事前に設定された安全なディレクトリ内に制限され、越界アクセスを防止します。
3. タイムアウト制御: 長時間応答しないタスクは自動的に終了され、過度のリソース占有を回避します。

セキュリティ警告

• 信頼できない環境では、ユーザー入力を直接コマンドパラメータとして使用しないでください。
• SSH 接続資格情報を定期的に更新し、パスワード漏洩のリスクを回避してください。
• 追加の認証手段（2 要素認証など）を有効にして、セキュリティを強化することをお勧めします。

📄 ライセンス

このプロジェクトは MIT ライセンスに準拠しています。

MIT License

Copyright (c) [年份] [作者姓名]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.