Verodat MCP Server

Überblick

Eine Model Context Protocol (MCP)-Serverimplementierung für Verodat , die eine nahtlose Integration der Datenverwaltungsfunktionen von Verodat mit KI-Systemen wie Claude Desktop ermöglicht.

Verodat MCP Server

Dieses Repository enthält eine Model Context Protocol (MCP)-Serverimplementierung für Verodat, die es KI-Modellen ermöglicht, über klar definierte Tools mit den Datenverwaltungsfunktionen von Verodat zu interagieren.

Überblick

Der Verodat MCP Server bietet KI-Modellen eine standardisierte Möglichkeit, auf Daten in Verodat zuzugreifen und diese zu bearbeiten. Er implementiert die Model Context Protocol-Spezifikation und bietet Tools für Datennutzung, -design und -verwaltung.

Werkzeugkategorien

Der Server ist in drei Haupttoolkategorien unterteilt, die jeweils einen progressiven Satz an Funktionen bieten:

1. Konsumieren (8 Werkzeuge)

Die Basiskategorie konzentrierte sich auf Datenabrufvorgänge:

get-accounts : Verfügbare Konten abrufen
get-workspaces : Arbeitsbereiche innerhalb eines Kontos auflisten
get-datasets : Datensätze in einem Arbeitsbereich auflisten
get-dataset-output : Aktuelle Daten aus einem Datensatz abrufen
get-dataset-targetfields : Felddefinitionen für einen Datensatz abrufen
get-queries : Ruft vorhandene KI-Abfragen ab
get-ai-context : Arbeitsbereichskontext und Datenstruktur abrufen
execute-ai-query : Führen Sie KI-gestützte Abfragen für Datensätze aus

2. Design (9 Werkzeuge)

Enthält alle Tools von Consume sowie:

create-dataset : Erstellen Sie einen neuen Datensatz mit definiertem Schema

3. Verwalten (10 Tools)

Enthält alle Tools von Design sowie:

upload-dataset-rows : Datenzeilen in vorhandene Datensätze hochladen

Voraussetzungen

Node.js (v18 oder höher)
Git
Claude Desktop (für die Claude-Integration)
Verodat-Konto und AI-API-Schlüssel

Installation

Schnellstart

Installation über Smithery

So installieren Sie den Verodat MCP Server für Claude Desktop automatisch über Smithery:

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

Manuelle Installation

Klonen Sie das Repository:

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

Installieren Sie Abhängigkeiten und erstellen Sie:

npm install
npm run build

Claude Desktop konfigurieren: Erstellen oder ändern Sie die Konfigurationsdatei:
- MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json
- Windows: %APPDATA%/Claude/claude_desktop_config.json
Fügen Sie die unten in der Konfiguration aufgeführte Konfiguration hinzu:

Erste Schritte mit Verodat

Registrieren Sie sich für ein Verodat-Konto unter verodat.com
Generieren Sie einen AI-API-Schlüssel von Ihrem Verodat-Dashboard
Fügen Sie den API-Schlüssel zu Ihrer Claude Desktop-Konfiguration hinzu

Konfiguration

Der Server erfordert eine Konfiguration für Authentifizierung und API-Endpunkte. Erstellen Sie eine Konfigurationsdatei für Ihr KI-Modell:

{
  "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"
      }
    }
  }
}

Konfigurationsoptionen

Sie können jede der drei Toolkategorien konfigurieren, indem Sie in Claude einzeln die entsprechende JS-Datei angeben:

Nur konsumieren : Verwenden Sie consume.js (8 Tools zum Datenabruf)
Designfunktionen : Verwenden Sie design.js (9 Tools, einschließlich Datensatzerstellung)
Vollständige Verwaltung : Verwenden Sie manage.js (10 Tools, einschließlich Datenupload)

Beispiel für die gleichzeitige Konfiguration aller drei Kategorien:

{
  "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"
      }
    }
  }
}

Umgebungsvariablen

VERODAT_AI_API_KEY : Ihr Verodat-API-Schlüssel zur Authentifizierung
VERODAT_API_BASE_URL : Die Basis-URL für die Verodat-API (standardmäßig „ https://verodat.io/api/v3 “, falls nicht anders angegeben)

Anleitung zur Werkzeugverwendung

Verfügbare Befehle

Der Server stellt die folgenden MCP-Befehle bereit:

// 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

Auswahl der richtigen Werkzeugkategorie

Für schreibgeschützte Vorgänge : Verwenden Sie die Serverkonfiguration consume.js
Zum Erstellen von Datensätzen : Verwenden Sie die Serverkonfiguration design.js
Zum Hochladen von Daten : Verwenden Sie die Serverkonfiguration manage.js

Sicherheitsüberlegungen

Authentifizierung über API-Schlüssel erforderlich
Die Anforderungsvalidierung stellt korrekt formatierte Daten sicher

Entwicklung

Die Codebasis ist in TypeScript geschrieben und wie folgt organisiert:

Tool-Handler : Implementierung der Funktionalität jedes Tools
Transportschicht : Behandelt die Kommunikation mit dem KI-Modell
Validierung : Stellt mithilfe von Zod-Schemata sicher, dass die Datenformate korrekt sind

Debuggen

Der MCP-Server kommuniziert über Standarddio, was das Debuggen erschweren kann. Wir bieten ein MCP-Inspector-Tool zur Unterstützung:

npm run inspector

Dadurch wird eine URL bereitgestellt, über die Sie in Ihrem Browser auf Debugging-Tools zugreifen können.

Beitragen

Wir freuen uns über Beiträge! Senden Sie uns gerne einen Pull Request.

Lizenz

LICENSE -Datei für Details

Unterstützung

Dokumentation: Verodat Docs
Probleme: GitHub-Probleme
Community: Verodat-Community

Verodat MCP Server

Integrations