Openbb Widgets Json MCP

🚀 OpenBB Widgets JSON MCP Server

OpenBBのwidgets.json仕様を構造化された呼び出し可能なツールとして公開するMCPサーバーです。開発者（およびClaude CodeのようなAIコーディングアシスタント）は、長いドキュメントを解析する代わりに、このサーバーを通じてウィジェットのタイプ、入力、および構成例を直接クエリできます。

🚀 クイックスタート

前提条件

• Python 3.12以上
• uvパッケージマネージャー
• Node.jsとnpx（Smithery CLIとプレイグラウンドを使用する場合、オプション）

手順

1. リポジトリをクローンする：

   git clone https://github.com/OpenBB-finance/openbb-widgets-json-mcp.git
   cd openbb-widgets-json-mcp
   

2. 依存関係をインストールする：

   uv sync
   

3. サーバーを起動する：

   uv run python main.py
   

4. 動作確認を行う： サーバーはhttp://localhost:8081で起動します。

5. Smitheryプレイグラウンドを起動する（オプション）：

   npm install -g @smithery/cli
   smithery playground --port 8081
   

   これにより、MCPツールを対話的にテストするためのインターフェースが開きます。

✨ 主な機能

各ウィジェットタイプは独自のツールにマッピングされているため、新しいOpenBBアプリを構築する際に有効なJSON仕様を簡単に生成、混合、およびマッチングできます。このサーバーはFastMCPを使用して構築され、OpenBB開発者ドキュメントからプログラムで生成され、Smithery.ai上にホストされているため、簡単に見つけることができます。

サーバーは以下を提供します：

• ウィジェットの構成とタイプのドキュメント
• ウィジェットのパラメーター（ドロップダウン、日付ピッカー、トグルなど）
• ウィジェット、アプリ、およびエージェントのJSON仕様
• OpenBBウィジェットを構築するための必須のボイラープレートコード
• データ統合とAIエージェントのドキュメント

💻 使用例

基本的な使用法

利用可能なMCPツール

OpenBBドキュメントを通じたもの

• ウィジェット構成ツール
  • widget_configuration_category_subcategory - カテゴリとサブカテゴリの構成
  • widget_configuration_error_handling - ウィジェットのエラーハンドリング
  • widget_configuration_grid_size - グリッドサイズの構成
  • widget_configuration_refetch_interval - 再取得間隔の設定
  • widget_configuration_render_functions - レンダリング関数
  • widget_configuration_run_button - 実行ボタンの構成
  • widget_configuration_stale_time - 古いデータの時間設定
• ウィジェットパラメーターツール
  • widget_parameters_text_input - テキスト入力パラメーター
  • widget_parameters_date_picker - 日付ピッカーパラメーター
  • widget_parameters_boolean_toggle - ブール値トグルパラメーター
  • widget_parameters_dropdown - ドロップダウンパラメーター
  • widget_parameters_advanced_dropdown - 高度なドロップダウンパラメーター
  • widget_parameters_dependent_dropdown - 依存ドロップダウンパラメーター
  • widget_parameters_number_input - 数値入力パラメーター
  • widget_parameters_input_form - 入力フォームパラメーター
  • widget_parameters_parameter_grouping - パラメーターグルーピング
  • widget_parameters_parameter_positioning - パラメーターの配置
  • widget_parameters_cell_click_grouping - セルクリックグルーピング
• ウィジェットタイプツール
  • widget_types_plotly_charts - Plotlyチャート
  • widget_types_highcharts - Highcharts
  • widget_types_tradingview_charts - TradingViewチャート
  • widget_types_aggrid_table_charts - AgGridテーブルチャート
  • widget_types_markdown - Markdownウィジェット
  • widget_types_html - HTMLウィジェット
  • widget_types_metric - メトリックウィジェット
  • widget_types_newsfeed - ニュースフィードウィジェット
  • widget_types_file_viewer - ファイルビューワーウィジェット
  • widget_types_live_grid - ライブグリッドウィジェット
  • widget_types_omni - Omniウィジェット
  • widget_types_ssrm_mode - SSRMモード
• JSON参照ツール
  • json_specs_widgets_json_reference - ウィジェットのJSON参照
  • json_specs_apps_json_reference - アプリのJSON参照
  • json_specs_agents_json_reference - エージェントのJSON参照
• 追加ツール
  • data_integration - データソースの統合
  • ai_agents_ai_agents - AIエージェントのドキュメント
  • apps_apps - OpenBBアプリケーションのドキュメント

追加されたもの

• building_widgets_on_openbb - OpenBBウィジェットの必須のボイラープレートコード（必ず最初に呼び出す）

高度な使用法

プレイグラウンドのモンテカルロウィジェットの例

playground/フォルダには、Claude CodeとこのMCPサーバーを使用して構築された完全なモンテカルロシミュレーションウィジェットが含まれています。これは、完全な開発ワークフローを示しています。

1. Claude CodeがMCPサーバーにOpenBBウィジェットの仕様を問い合わせます。
2. MCPツールがボイラープレートコード、Plotlyチャートのドキュメント、およびJSON参照仕様を提供します。
3. 生成されたウィジェットには以下が含まれます：

• 3つのパラメーター：ティッカー（テキスト）、開始日（日付）、ボラティリティ調整の使用（ブール値）
• 50のシミュレーションパスとパーセンタイルバンドを持つPlotlyビジュアライゼーション
• 純粋なシミュレーション配列を返す生データモード
• 手動実行用の実行ボタン
• 完全なOpenBBワークスペース統合

この例を実行するには：

cd playground
uv sync
uv run python main.py

これは、AIコーディングアシスタントがMCPサーバーを利用して、構造化されたドキュメントにプログラムでアクセスすることで、準拠したOpenBBウィジェットを迅速に構築できる実用的な例となっています。

📚 ドキュメント

Smitheryへのデプロイ

MCPサーバーをデプロイするには：

• コードをGitHubにプッシュします（smithery.yamlとDockerfileを含める）
• https://smithery.ai/newでリポジトリを接続します

サーバーはHTTP経由で利用可能になり、MCP互換のクライアントですぐに使用できます！

サーバーの停止

ターミナルでCtrl+Cを押してサーバーを停止します。