Веродат MCP Сервер

Обзор

Реализация сервера Model Context Protocol (MCP) для Verodat , обеспечивающая беспроблемную интеграцию возможностей управления данными Verodat с системами искусственного интеллекта, такими как Claude Desktop.

Веродат MCP Сервер

В этом репозитории содержится реализация сервера Model Context Protocol (MCP) для Verodat, позволяющая моделям ИИ взаимодействовать с возможностями управления данными Verodat с помощью четко определенных инструментов.

Обзор

Verodat MCP Server предоставляет стандартизированный способ доступа и манипулирования данными в Verodat для моделей ИИ. Он реализует спецификацию Model Context Protocol, предоставляя инструменты для потребления данных, проектирования и управления.

Категории инструментов

Сервер разделен на три основные категории инструментов, каждая из которых предлагает прогрессивный набор возможностей:

1. Потребление (8 инструментов)

Базовая категория, ориентированная на операции по извлечению данных:

get-accounts : Получить доступные учетные записи
get-workspaces : Список рабочих пространств в учетной записи
get-datasets : список наборов данных в рабочей области
get-dataset-output : Извлечение фактических данных из набора данных
get-dataset-targetfields : Извлечение определений полей для набора данных
get-queries : Извлечение существующих запросов ИИ
get-ai-context : Получить контекст рабочего пространства и структуру данных
execute-ai-query : выполнение запросов с использованием искусственного интеллекта к наборам данных

2. Дизайн (9 инструментов)

Включает все инструменты Consume, а также:

create-dataset : создать новый набор данных с определенной схемой

3. Управление (10 инструментов)

Включает все инструменты Design, а также:

upload-dataset-rows : загрузка строк данных в существующие наборы данных

Предпосылки

Node.js (v18 или выше)
Гит
Claude Desktop (для интеграции Claude)
Аккаунт Verodat и ключ API AI

Установка

Быстрый старт

Установка через Smithery

Чтобы автоматически установить Verodat MCP Server для Claude Desktop через Smithery:

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

Ручная установка

Клонируйте репозиторий:

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

Установка зависимостей и сборка:

npm install
npm run build

Настройте Claude Desktop: создайте или измените файл конфигурации:
- MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- Windows: %APPDATA%/Claude/claude_desktop_config.json
Добавьте конфигурацию, указанную ниже в конфигурации:

Начало работы с Verodat

Зарегистрируйте учетную запись Verodat на verodat.com
Сгенерируйте ключ API AI из панели управления Verodat
Добавьте ключ API в конфигурацию Claude Desktop

Конфигурация

Сервер требует настройки для аутентификации и конечных точек API. Создайте файл конфигурации для вашей модели AI, чтобы использовать:

{
  "mcpServers": {
    "verodat-consume": {
      "command": "node",
      "args": [
        "path/to/verodat-mcp-server/build/src/consume.js"
      ],
      "env": {
        "VERODAT_AI_API_KEY": "your-api-key",
        "VERODAT_API_BASE_URL": "https://verodat.io/api/v3"
      }
    }
  }
}

Параметры конфигурации

Вы можете настроить любую из трех категорий инструментов, указав соответствующий JS-файл по одному в claude:

Только потребление : используйте consume.js (8 инструментов для извлечения данных)
Возможности дизайна : использование design.js (9 инструментов, включая создание набора данных)
Полное управление : используйте manage.js (10 инструментов, включая загрузку данных)

Пример настройки всех трех категорий одновременно:

{
  "mcpServers": {
    "verodat-consume": {
      "command": "node",
      "args": [
        "path/to/verodat-mcp-server/build/src/consume.js"
      ],
      "env": {
        "VERODAT_AI_API_KEY": "your-api-key",
        "VERODAT_API_BASE_URL": "https://verodat.io/api/v3"
      }
    },
    "verodat-design": {
      "command": "node",
      "args": [
        "path/to/verodat-mcp-server/build/src/design.js"
      ],
      "env": {
        "VERODAT_AI_API_KEY": "your-api-key",
        "VERODAT_API_BASE_URL": "https://verodat.io/api/v3"
      }
    },
    "verodat-manage": {
      "command": "node",
      "args": [
        "path/to/verodat-mcp-server/build/src/manage.js"
      ],
      "env": {
        "VERODAT_AI_API_KEY": "your-api-key",
        "VERODAT_API_BASE_URL": "https://verodat.io/api/v3"
      }
    }
  }
}

Переменные среды

VERODAT_AI_API_KEY : Ваш ключ API Verodat для аутентификации
VERODAT_API_BASE_URL : базовый URL для API Verodat (по умолчанию « https://verodat.io/api/v3 », если не указано иное)

Руководство по использованию инструмента

Доступные команды

Сервер предоставляет следующие команды MCP:

// Account & Workspace Management
get-accounts        // List accessible accounts
get-workspaces      // List workspaces in an account
get-queries         // Retrieve existing AI queries

// Dataset Operations
create-dataset      // Create a new dataset
get-datasets        // List datasets in a workspace
get-dataset-output  // Retrieve dataset records
get-dataset-targetfields // Retrieve dataset targetfields
upload-dataset-rows // Add new data rows to an existing dataset

// AI Operations
get-ai-context      // Get workspace AI context
execute-ai-query    // Run AI queries on datasets

Выбор правильной категории инструментов

Для операций только для чтения : используйте конфигурацию сервера consume.js
Для создания наборов данных : используйте конфигурацию сервера design.js
Для загрузки данных : используйте конфигурацию сервера manage.js

Соображения безопасности

Требуется аутентификация с помощью ключа API
Проверка запроса гарантирует правильность форматирования данных.

Разработка

Кодовая база написана на TypeScript и организована следующим образом:

Обработчики инструментов : реализация функциональности каждого инструмента
Транспортный уровень : обеспечивает связь с моделью ИИ.
Проверка : обеспечивает правильные форматы данных с использованием схем Zod.

Отладка

Сервер MCP взаимодействует через stdio, что может усложнить отладку. Мы предоставляем инструмент MCP Inspector, который поможет:

npm run inspector

Это предоставит URL-адрес для доступа к инструментам отладки в вашем браузере.

Внося вклад

Мы приветствуем вклады! Пожалуйста, не стесняйтесь отправлять запрос на извлечение.

Лицензия

Файл ЛИЦЕНЗИЯ для получения подробной информации

Поддерживать

Документация: Verodat Docs
Проблемы: Проблемы GitHub
Сообщество: Сообщество Веродат

Verodat MCP Server

Integrations