Verodat MCP Server 使用说明

项目简介

Verodat MCP Server 是一个基于 Model Context Protocol (MCP) 标准构建的服务器，旨在将 Verodat 数据管理平台的功能无缝集成到各类 AI 系统中，如 Claude Desktop。通过提供结构化的数据访问和 AI 功能接口，它使得 LLM 客户端能够安全、便捷地利用 Verodat 平台上的数据资源和 AI 能力。

主要功能点

账号与工作空间管理：
- 列出可访问的 Verodat 账号和工作空间。
数据集操作：
- 创建具有自定义模式和验证规则的数据集。
- 查询和过滤数据集。
- 获取数据集记录。
AI 功能集成：
- 获取工作空间的 AI 上下文信息。
- 执行 AI 驱动的数据查询。

安装步骤

方法一：使用 Smithery 自动安装 (推荐 Claude Desktop 用户)

打开终端，运行以下命令：

npx -y @smithery/cli install @Verodat/verodat-mcp-server --client claude

Smithery 会自动下载并安装 Verodat MCP Server，并配置 Claude Desktop。

方法二：手动安装

克隆仓库：

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

安装依赖并构建：

npm install
npm run build

服务器配置

对于 MCP 客户端（例如 Claude Desktop），您需要配置 MCP 服务器的启动信息。以下是配置示例，以 Claude Desktop 为例：

打开 Claude Desktop 配置文件：
- MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
- Windows: '%APPDATA%/Claude/claude_desktop_config.json'

添加或修改 'mcpServers' 配置： 在配置文件中找到 'mcpServers' 部分（如果没有则创建），并添加 Verodat MCP Server 的配置信息。

{
    "mcpServers": {
        "verodat": { // 服务器名称，可以自定义
            "command": "node", // 启动服务器的命令，这里使用 Node.js 运行 JavaScript 文件
            "args": ["path/to/verodat-mcp-server/build/src/index.js"], // 服务器启动参数，指向构建后的入口文件路径。请替换 "path/to/verodat-mcp-server" 为您实际的仓库路径。
            "env": {
                "VERODAT_AI_API_KEY": "your-verodat-ai-api-key" // 环境变量，用于配置 Verodat AI API 密钥。请替换 "your-verodat-ai-api-key" 为您在 Verodat 平台生成的 API 密钥。
            }
        }
    }
}

注意:

请将 'path/to/verodat-mcp-server' 替换为 Verodat MCP Server 仓库在您本地文件系统中的绝对路径。
将 'your-verodat-ai-api-key' 替换为您的 Verodat AI API 密钥。您需要在 Verodat 官网注册账号并生成 API 密钥。

基本使用方法

启动 MCP 服务器： (如果使用 Smithery 安装，通常会自动启动。手动安装则根据 Claude Desktop 的配置，当 Claude Desktop 尝试连接 MCP 服务器时会自动启动。)
在 MCP 客户端中使用工具： 配置完成后，您可以在 Claude Desktop 或其他 MCP 客户端中使用 Verodat MCP Server 提供的工具。工具名称和功能描述可以在仓库的 'README.md' 文件或 'src/handlers/requestHandlers.ts' 文件中找到。常用的工具包括：
- 'get-accounts': 获取 Verodat 账号列表。
- 'get-workspaces': 获取指定账号下的工作空间列表。
- 'get-datasets': 获取指定工作空间下的数据集列表。
- 'get-dataset-output': 获取数据集的数据记录。
- 'execute-ai-query': 执行 AI 查询。
您可以在 MCP 客户端的界面中，通过自然语言指令或工具调用方式，使用这些工具与 Verodat 数据平台进行交互。

关键词