Verodat MCP Server

🚀 Verodat MCP 服務器版本

Verodat MCP 服務器是一款用於和 Verodat 平臺進行交互的工具，支持賬戶與工作區管理、數據集操作以及 AI 操作等多種功能。該服務器採用 TypeScript 編寫，還提供了詳細的文檔和社區支持。

🚀 快速開始

Verodat MCP 服務器支持多種操作，涵蓋賬戶和工作區管理、數據集操作以及 AI 操作等。它使用 TypeScript 編寫，為用戶提供了豐富的功能和便捷的操作體驗。

✨ 主要特性

• 多種操作支持：涵蓋賬戶和工作區管理、數據集操作以及 AI 操作。
• 詳細文檔與社區支持：提供詳細的文檔和活躍的社區支持，方便用戶使用和交流。
• TypeScript 編寫：保證代碼的可維護性和類型安全。

📦 安裝指南

快速安裝

使用 Smithery CLI 進行快速安裝：

npm install -g @verodat/mcp-server

手動安裝

1. 克隆倉庫：

   git clone https://github.com/Verodat/verodat-mcp-server.git
   cd verodat-mcp-server
   

2. 安裝依賴：

   npm install
   

3. 構建項目：

   npm run build
   

📚 詳細文檔

工具分類

1. Consume（讀取操作）

• get-accounts：列出可訪問的賬戶。
• get-workspaces：列出賬戶中的工作區。
• get-queries：檢索現有的 AI 查詢。

2. Design（創建數據集）

• create-dataset：創建新的數據集。
• get-datasets：列出工作區中的數據集。
• get-dataset-output：檢索數據集記錄。
• get-dataset-targetfields：檢索數據集的目標字段。

3. Manage（上傳數據）

• upload-dataset-rows：向現有數據集添加新數據行。

配置指南

環境變量

• VERODAT_AI_API_KEY：用於身份驗證的 Verodat API 密鑰。
• VERODAT_API_BASE_URL：Verodat API 的基礎 URL，默認為 "https://verodat.io/api/v3"。

工具使用指南

可用命令

// 賬戶及工作區管理
get-accounts        # 列出可訪問的賬戶
get-workspaces      # 列出賬戶中的工作區
get-queries         # 檢索現有的 AI 查詢

// 數據集操作
create-dataset      # 創建新的數據集
get-datasets        # 列出工作區中的數據集
get-dataset-output  # 檢索數據集記錄
get-dataset-targetfields # 檢索數據集的目標字段
upload-dataset-rows # 向現有數據集添加新數據行

// AI 操作
get-ai-context      # 獲取工作區的 AI 上下文
execute-ai-query    # 在數據集上執行 AI 查詢

選擇合適的工具類別

• 僅讀操作：使用 consume.js 配置。
• 創建數據集：使用 design.js 配置。
• 上傳數據：使用 manage.js 配置。

安全注意事項

• 所有請求均需通過 API 密鑰進行身份驗證。
• 請求會經過格式驗證，確保數據正確性。

開發指南

代碼結構

• 工具處理程序：實現每個工具的功能。
• 傳輸層：負責與 AI 模型的通信。
• 驗證：使用 Zod 架構確保數據格式正確。

調試工具

運行以下命令啟動調試工具：

npm run inspector

這將提供一個訪問調試工具的 URL。

🔧 技術細節

• 語言：TypeScript
• 驗證架構：Zod 架構用於確保數據格式正確。
• 通信：通過傳輸層與 AI 模型進行通信。

📄 許可證

文檔中未提及相關內容。

項目支持

• 文檔：Verodat 文檔
• 問題：GitHub 問題
• 社區：Verodat 社區

通過以上內容，您可以詳細瞭解和使用 Verodat MCP 服務器。如有任何問題或建議，請隨時聯繫支持團隊。