🚀 Verodat MCP 服务器
Verodat MCP 服务器提供了一套完整的功能，可用于帐户与工作区管理、数据集操作以及 AI 操作。通过它，用户可以便捷地管理数据和执行 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 查询
📦 安装指南
先决条件
- 安装 Node.js：确保已安装最新稳定版本的 Node.js 和 npm。
- 安装依赖项：运行以下命令以安装项目所需的依赖项：
npm install
安装方式
方式一：通过 npm 安装
npm install verodat-mcp-server
方式二：手动构建
- 克隆仓库：
git clone https://github.com/Verodat/verodat-mcp-server.git cd verodat-mcp-server - 安装依赖并构建：
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配置
安全注意事项
- 所有请求均需通过 API 密钥进行身份验证。
- 请求验证确保了数据格式的正确性。
开发指南
代码结构
- 工具处理程序：实现每个工具的功能逻辑
- 传输层：负责与 AI 模型的通信
- 验证：确保所有请求的安全性和规范性
运行开发服务器
npm run dev
文档地址
更多详细文档，请访问 Verodat 官方文档。