Skip to content

TUI エクスプローラー

概要

swag2mcp には組み込みの TUI(Terminal User Interface)が含まれており、対話的に API を探索できます。ターミナルから離れることなく API エンドポイントを検索、ブラウズ、調査、呼び出しできるフルスクリーンターミナルアプリケーションです。

起動

bash
swag2mcp run

設定ファイルが存在しない場合、TUI は自動的に初期化ウィザードを起動します。

モード

TUI には 3 つのモードがあり、Tab キーで切り替えられます:

検索モード

すべての spec の全エンドポイントに対する全文検索。search MCP ツールと同じクエリ構文をサポートします。

  • クエリを入力してエンドポイント名、パス、説明を検索
  • メソッド、タグ、パスで結果をフィルタリング
  • 1 回のキー操作でエンドポイントの詳細を表示
  • ページネーションで結果を移動(1 ページ 10 項目)

ブラウズモード

spec 階層のツリー移動:

Spec → Collection → Tag → Endpoint
  • ツリーを下って特定のエンドポイントを見つける
  • エンドポイントの詳細を表示(パラメーター、リクエストボディ、レスポンス)
  • TUI から直接 API を呼び出す
  • エンドポイントの詳細を JSON ファイルとして保存

認証モード

任意の spec の認証トークンとヘッダーを表示。デバッグや curl コマンドの生成に便利です。

コントロール

キーアクション
/ 上下に移動
Enter選択または開く
Esc1 つ前のレベルに戻る
Tab検索、ブラウズ、認証モードを切り替え
/検索入力をフォーカス
N / P次 / 前のページ
B前の画面に戻る
Mメインメニューに戻る
Sエンドポイントの詳細を JSON ファイルとして保存
q / Ctrl+C終了

状態

移動中に TUI は以下の状態を経由します:

  1. Loading — ワークスペースからデータを読み込み中
  2. Search — クエリ入力のある検索モード
  3. Browse — spec リストのあるブラウズモード
  4. Spec List — すべての spec のリスト
  5. Collection List — spec 内の collection
  6. Tag List — collection 内のタグ
  7. Endpoint List — タグ内のエンドポイント
  8. Endpoint Detail — 完全なエンドポイント情報
  9. Invoke Result — API 呼び出し結果
  10. Error — メッセージ付きエラー状態

エンドポイント詳細表示

エンドポイントを選択すると、TUI は以下を表示します:

  • HTTP メソッドとパス
  • ベース URL と完全な URL
  • サマリーと説明
  • すべてのパラメーター(名前、場所、型、必須)
  • リクエストボディスキーマ(該当する場合)
  • レスポンスコードとスキーマ
  • 非推奨ステータス

要件

  • ターミナルサイズ: 最低 80×24 文字
  • ターミナルエミュレーター: 最新のほとんどのターミナルで動作(iTerm2、Terminal.app、GNOME Terminal、Windows Terminal など)
  • SSH: SSH 接続でも動作

重要な注意点

  • 自動初期化 — 設定ファイルが存在しない場合、TUI は自動的に初期化ウィザードを起動します
  • ページネーション — リストは 1 ページ 10 項目でページネーションされます。NP で移動
  • エンドポイント詳細の保存 — エンドポイント詳細表示で S を押すと、完全な詳細をカレントディレクトリに JSON ファイルとして保存
  • 認証モード — デバッグ用のトークンとヘッダーを表示。本番環境では --disable-llm-auth で認証ツールを無効化できます