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 服务器。如有任何问题或建议，请随时联系支持团队。