Verodat

🚀 Verodat MCP 服務器

Verodat MCP 服務器是一款功能強大的工具，它提供了帳戶與工作區管理、數據集操作以及 AI 操作等多種功能。本項目能幫助用戶高效地管理數據和執行 AI 查詢，提升工作效率。

🚀 快速開始

Verodat MCP 服務器提供了豐富的功能，涵蓋帳戶與工作區管理、數據集操作以及 AI 操作等多個方面。在開始使用前，請確保滿足先決條件，並按照安裝和配置指南完成相關設置。

✨ 主要特性

該服務器的功能劃分為以下幾類：

帳戶與工作區管理

• 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 查詢

📦 安裝指南

先決條件

1. 安裝 Node.js：確保已安裝最新穩定版本的 Node.js 和 npm。
2. 安裝依賴項：運行以下命令以安裝項目所需的依賴項：

   npm install
   

安裝方式

方式一：通過 npm 安裝

npm install verodat-mcp-server

方式二：手動構建

1. 克隆倉庫：

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

2. 安裝依賴並構建：

   npm install && npm run build
   

📚 詳細文檔

配置指南

環境變量

以下是服務器運行所需的環境變量：

• VERODAT_API_KEY：您的 Verodat API 密鑰
• VERODAT_API_BASE_URL（可選）：Verodat API 的基礎 URL，默認為 https://verodat.io/api/v3

示例配置

consume.js 配置

{
  "name": "verodat-consume",
  "command": "node",
  "args": ["src/consume.js"],
  "env": {
    "VERODAT_API_KEY": "your_api_key_here",
    "VERODAT_API_BASE_URL": "https://verodat.io/api/v3"
  }
}

design.js 配置

{
  "name": "verodat-design",
  "command": "node",
  "args": ["src/design.js"],
  "env": {
    "VERODAT_API_KEY": "your_api_key_here",
    "VERODAT_API_BASE_URL": "https://verodat.io/api/v3"
  }
}

manage.js 配置

{
  "name": "verodat-manage",
  "command": "node",
  "args": ["src/manage.js"],
  "env": {
    "VERODAT_API_KEY": "your_api_key_here",
    "VERODAT_API_BASE_URL": "https://verodat.io/api/v3"
  }
}

使用指南

可用命令

以下是服務器支持的 MCP 命令：

# 帳戶與工作區管理
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 配置

安全注意事項

1. 所有請求均需通過 API 密鑰進行身份驗證。
2. 請求驗證確保了數據格式的正確性。

開發指南

代碼結構

• 工具處理程序：實現每個工具的功能邏輯
• 傳輸層：負責與 AI 模型的通信
• 驗證：確保所有請求的安全性和規範性

運行開發服務器

npm run dev

文檔地址

更多詳細文檔，請訪問 Verodat 官方文檔。