Openbb Widgets Json MCP

🚀 OpenBB Widgets JSON MCP 服務器

OpenBB Widgets JSON MCP 服務器將 OpenBB 的 widgets.json 規範以結構化、可調用的工具形式呈現。開發者（以及像 Claude Code 這樣的 AI 代碼助手）無需再解析冗長的文檔，可直接通過該服務器查詢小部件類型、輸入和配置示例。

🚀 快速開始

前提條件

• Python 3.12 或更高版本
• uv 包管理器
• Node.js 和 npx（可選，用於 Smithery CLI 和 playground）

操作步驟

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 Playground（可選）：

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

這將打開一個界面，用於交互式測試 MCP 工具。

✨ 主要特性

每個小部件類型都對應一個獨立的工具，便於在構建新的 OpenBB 應用時生成、混合和匹配有效的 JSON 規範。該服務器使用 FastMCP 構建，從 OpenBB 開發者文檔以編程方式生成，並託管在 Smithery.ai 上，方便發現和使用。

服務器提供以下內容：

• 小部件配置和類型文檔
• 小部件參數（下拉框、日期選擇器、開關等）
• 小部件、應用和代理的 JSON 規範
• 構建 OpenBB 小部件所需的基本樣板代碼
• 數據集成和 AI 代理文檔

💻 使用示例

基礎用法

以下是一個通過 MCP 服務器構建 OpenBB 小部件的基礎示例，以 playground/ 文件夾中的蒙特卡羅模擬小部件為例：

cd playground
uv sync
uv run python main.py

高級用法

該示例展示了完整的開發工作流程：

1. Claude Code 向 MCP 服務器查詢 OpenBB 小部件規範。
2. MCP 工具 提供樣板代碼、Plotly 圖表文檔和 JSON 參考規範。
3. 生成的小部件 包含：
   • 3 個參數：股票代碼（文本）、開始日期（日期）、是否使用波動率調整（布爾值）。
   • 帶有 50 條模擬路徑和百分位數帶的 Plotly 可視化。
   • 返回純模擬數組的原始數據模式。
   • 用於手動執行的運行按鈕。
   • 與完整的 OpenBB 工作區集成。

📦 可用的 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 - 全能小部件
• 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 小部件的基本樣板代碼（務必首先調用此工具）

🚀 部署到 Smithery

要部署你的 MCP 服務器：

• 將代碼推送到 GitHub（包含 smithery.yaml 和 Dockerfile）。
• 在 https://smithery.ai/new 連接你的倉庫。

部署後，你的服務器將通過 HTTP 可用，並可與任何 MCP 兼容的客戶端配合使用！

🔧 停止服務器

在終端中按 Ctrl+C 停止服務器。