Verodat MCP サーバー

概要

Verodatのモデル コンテキスト プロトコル (MCP) サーバー実装。これにより、Verodat のデータ管理機能と Claude Desktop などの AI システムをシームレスに統合できます。

Verodat MCP サーバー

このリポジトリには、Verodat のモデル コンテキスト プロトコル (MCP) サーバー実装が含まれており、AI モデルは明確に定義されたツールを通じて Verodat のデータ管理機能と対話できます。

Related MCP server: MCP Claude Code

概要

Verodat MCPサーバーは、AIモデルがVerodat内のデータにアクセスし、操作するための標準化された方法を提供します。モデルコンテキストプロトコル仕様を実装し、データの利用、設計、管理のためのツールを提供します。

ツールカテゴリ

サーバーは 3 つの主要なツール カテゴリに分かれており、それぞれが段階的な機能セットを提供しています。

1. 消費する（8つのツール）

データ取得操作に重点を置いた基本カテゴリ:

• get-accounts : 利用可能なアカウントを取得する

• get-workspaces : アカウント内のワークスペースを一覧表示する

• get-datasets : ワークスペース内のデータセットを一覧表示する

• get-dataset-output : データセットから実際のデータを取得する

• get-dataset-targetfields : データセットのフィールド定義を取得する

• get-queries : 既存のAIクエリを取得する

• get-ai-context : ワークスペースのコンテキストとデータ構造を取得する

• execute-ai-query : データセットに対してAIを活用したクエリを実行する

2. デザイン（9つのツール）

Consume のすべてのツールに加えて、次のものが含まれます。

• create-dataset : 定義されたスキーマで新しいデータセットを作成する

3. 管理（10個のツール）

デザインのすべてのツールに加えて、次のものが含まれます。

• upload-dataset-rows : 既存のデータセットにデータ行をアップロードする

前提条件

• Node.js (v18以上)

• ギット

• Claude デスクトップ (Claude 統合用)

• VerodatアカウントとAI APIキー

インストール

クイックスタート

Smithery経由でインストール

Smithery 経由で Claude Desktop 用の Verodat MCP Server を自動的にインストールするには:

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

手動インストール

1. リポジトリをクローンします。

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

2. 依存関係をインストールしてビルドします。

npm install
npm run build

3. Claude Desktop を構成する: 構成ファイルを作成または変更します。

   • MacOS: ~/Library/Application Support/Claude/claude_desktop_config.json

   • Windows: %APPDATA%/Claude/claude_desktop_config.json構成に以下に示す構成を追加します。

Verodatを使い始める

1. verodat.comでVerodatアカウントを登録してください

2. VerodatダッシュボードからAI APIキーを生成する

3. Claude Desktop 構成に API キーを追加します

構成

サーバーには認証と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"
      }
    }
  }
}

設定オプション

claude で適切な JS ファイルを 1 つずつ指定することで、3 つのツール カテゴリのいずれかを構成できます。

• 消費のみ： consume.jsを使用する（データ取得用の 8 つのツール）

• デザイン機能: design.jsを使用 (9 つのツール、データセット作成を含む)

• 完全な管理： manage.jsを使用（10 個のツール、データのアップロードを含む）

3 つのカテゴリを同時に構成する例:

{
  "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 : 認証用の Verodat API キー

• VERODAT_API_BASE_URL : Verodat API のベース URL (指定されていない場合はデフォルトで " 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 で記述されており、次のように構成されています。

• ツールハンドラー:各ツールの機能の実装

• トランスポート層: AIモデルとの通信を処理する

• 検証: Zodスキーマを使用して適切なデータ形式を保証します

デバッグ

MCPサーバーはstdio経由で通信するため、デバッグが困難になる場合があります。そのため、MCP Inspectorツールをご用意しています。

npm run inspector

これにより、ブラウザでデバッグ ツールにアクセスするための URL が提供されます。

貢献

貢献を歓迎します！お気軽にプルリクエストを送信してください。

ライセンス

詳細についてはLICENSEファイルをご覧ください

サポート

• ドキュメント: Verodat ドキュメント

• 問題: GitHub の問題

• コミュニティ: Verodat コミュニティ