Readme: Metabase MCP Server

Metabase統合のための包括的なModel Context Protocol (MCP)サーバーです。AIアシスタントにMetabaseの分析プラットフォームへの完全なアクセスを提供します。

🚀 クイックスタート

# Install and run with npx
export METABASE_URL=https://your-metabase-instance.com
export METABASE_API_KEY=your_metabase_api_key
npx @cognitionai/metabase-mcp-server

Related MCP server: Metabase MCP Server

✨ 機能

🎯 利用可能なツール81以上 - Metabase APIの完全なカバレッジ

• 📊 ダッシュボード管理 (23ツール) - 完全なCRUD操作、カード管理、公開共有、埋め込み

• 📈 カード/質問管理 (21ツール) - クエリ実行、パラメータ処理、ピボットクエリ、公開リンク

• 🗄️ データベース管理 (13ツール) - 接続管理、スキーマ同期、クエリ実行

• 📋 テーブル管理 (16ツール) - メタデータ操作、フィールド管理、データ操作

• 🔍 追加ツール (9ツール) - コレクション、検索、ユーザー、アクティビティ追跡、プレイグラウンドリンク

📦 インストール

💡 推奨: 最適な互換性のためにNode.js 20.19.0+とnpm 8.0.0+

方法1: NPX（推奨）

npx @cognitionai/metabase-mcp-server

方法2: グローバルインストール

npm install -g @cognitionai/metabase-mcp-server
metabase-mcp-server

方法3: Docker

docker run -it --rm \
  -e METABASE_URL=https://your-metabase-instance.com \
  -e METABASE_API_KEY=your_metabase_api_key \
  ghcr.io/CognitionAI/metabase-mcp-server

⚙️ 設定

環境変数

APIキー認証（推奨）:

export METABASE_URL=https://your-metabase-instance.com
export METABASE_API_KEY=your_metabase_api_key

ユーザー名/パスワード認証（フォールバック）:

export METABASE_URL=https://your-metabase-instance.com
export METABASE_USERNAME=your_username
export METABASE_PASSWORD=your_password

オプション引数

サーバーはツールの読み込みをカスタマイズするためのコマンドライン引数をサポートしています:

• --essential (デフォルト): 必須ツールのみを読み込む

• --all: 利用可能な80以上のツールをすべて読み込む

• --write: 書き込み/変更ツールのみを読み込む

• --read: 読み取り専用ツールのみを読み込む

# Using published package (recommended)
# Default behavior (essential tools only)
npx @cognitionai/metabase-mcp-server

# Load all tools
npx @cognitionai/metabase-mcp-server --all

# Load only write tools
npx @cognitionai/metabase-mcp-server --write

# Load only read-only tools
npx @cognitionai/metabase-mcp-server --read

# Using local development build
npm run build
node dist/server.js                    # Default (essential tools)
node dist/server.js --all             # All tools
node dist/server.js --write           # Write tools only
node dist/server.js --read            # Read-only tools only

🔌 統合例

Claude Desktop

Claude Desktopの設定（macOSでは~/Library/Application Support/Claude/claude_desktop_config.json）に追加:

公開済みパッケージを使用:

{
  "mcpServers": {
    "metabase": {
      "command": "npx",
      "args": ["@cognitionai/metabase-mcp-server"],
      "env": {
        "METABASE_URL": "https://your-metabase-instance.com",
        "METABASE_API_KEY": "your_metabase_api_key"
      }
    }
  }
}

ローカル開発ビルドを使用:

{
  "mcpServers": {
    "metabase": {
      "command": "node",
      "args": ["/path/to/metabase-mcp-server/dist/server.js"],
      "env": {
        "METABASE_URL": "https://your-metabase-instance.com",
        "METABASE_API_KEY": "your_metabase_api_key"
      }
    }
  }
}

カスタムフラグを使用:

{
  "mcpServers": {
    "metabase-all": {
      "command": "npx",
      "args": ["@cognitionai/metabase-mcp-server", "--all"],
      "env": {
        "METABASE_URL": "https://your-metabase-instance.com",
        "METABASE_API_KEY": "your_metabase_api_key"
      }
    }
  }
}

Windsurf IDE

Windsurf MCPの設定（~/.windsurf/mcp_config.json）に追加:

公開済みパッケージを使用:

{
  "mcpServers": {
    "metabase": {
      "command": "npx",
      "args": ["@cognitionai/metabase-mcp-server"],
      "env": {
        "METABASE_URL": "https://your-metabase-instance.com",
        "METABASE_API_KEY": "your_metabase_api_key"
      }
    }
  }
}

ローカル開発ビルドを使用:

{
  "mcpServers": {
    "metabase": {
      "command": "node",
      "args": ["/path/to/metabase-mcp-server/dist/server.js"],
      "env": {
        "METABASE_URL": "https://your-metabase-instance.com",
        "METABASE_API_KEY": "your_metabase_api_key"
      }
    }
  }
}

カスタムフラグを使用:

{
  "mcpServers": {
    "metabase-read": {
      "command": "npx",
      "args": ["@cognitionai/metabase-mcp-server", "--read"],
      "env": {
        "METABASE_URL": "https://your-metabase-instance.com",
        "METABASE_API_KEY": "your_metabase_api_key"
      }
    },
    "metabase-write": {
      "command": "npx",
      "args": ["@cognitionai/metabase-mcp-server", "--write"],
      "env": {
        "METABASE_URL": "https://your-metabase-instance.com",
        "METABASE_API_KEY": "your_metabase_api_key"
      }
    }
  }
}

🛠️ 利用可能なツール

コア操作

• list_dashboards - すべてのダッシュボードを一覧表示

• get_dashboard - IDでダッシュボードを取得

• create_dashboard - 新しいダッシュボードを作成

• update_dashboard - 既存のダッシュボードを更新

• delete_dashboard - ダッシュボードを削除

• copy_dashboard - ダッシュボードをコピー

カード管理

• get_dashboard_cards - ダッシュボード内のすべてのカードを取得

• add_card_to_dashboard - カードをダッシュボードに追加

• remove_card_from_dashboard - カードをダッシュボードから削除

• update_dashboard_card - カードの位置/設定を更新

• execute_dashboard_card - 特定のダッシュボードカードを実行

公開共有と埋め込み

• create_public_link - 公開ダッシュボードリンクを作成

• delete_public_link - 公開ダッシュボードリンクを削除

• list_public_dashboards - 公開ダッシュボードを一覧表示

• list_embeddable_dashboards - 埋め込み可能なダッシュボードを一覧表示

パラメータとクエリ

• get_dashboard_param_values - パラメータ値を取得

• search_dashboard_param_values - パラメータ値を検索

• get_dashboard_param_remapping - パラメータのリマッピングを取得

• execute_dashboard_query - ダッシュボードクエリを実行

高度な機能

• get_dashboard_related - 関連コンテンツを取得

• get_dashboard_query_metadata - クエリメタデータを取得

• update_dashboard_cards - カードを一括更新

• save_dashboard - ダッシュボードの変更を保存

• get_dashboard_items - ダッシュボード項目を取得

コア操作

• list_cards - すべてのカード/質問を一覧表示

• get_card - IDでカードを取得

• create_card - 新しいカードを作成

• update_card - 既存のカードを更新

• delete_card - カードを削除

• copy_card - カードをコピー

クエリ実行

• execute_card - カードクエリを実行

• execute_card_query_with_format - 特定の形式で実行

• execute_pivot_card_query - ピボットクエリを実行

• get_card_query_metadata - クエリメタデータを取得

カード管理

• move_cards - コレクション間でカードを移動

• move_cards_to_collection - コレクションへ一括移動

• get_card_dashboards - カードを含むダッシュボードを取得

• get_card_series - カードシリーズデータを取得

パラメータと値

• get_card_param_values - パラメータ値を取得

• search_card_param_values - パラメータ値を検索

• get_card_param_remapping - パラメータのリマッピングを取得

公開共有

• create_card_public_link - 公開カードリンクを作成

• delete_card_public_link - 公開カードリンクを削除

• get_public_cards - 公開カードを一覧表示

• get_embeddable_cards - 埋め込み可能なカードを一覧表示

コア操作

• list_databases - すべてのデータベースを一覧表示

• get_database - データベースの詳細を取得

• create_database - データベース接続を作成

• update_database - データベース設定を更新

• delete_database - データベース接続を削除

スキーマとメタデータ

• get_database_schema_tables - データベースのテーブルを取得

• get_database_schemas - データベースのスキーマを取得

• get_database_metadata - 完全なメタデータを取得

• sync_database_schema - スキーマメタデータを同期

クエリ操作

• execute_query - SQLクエリを実行

• execute_query_export - 実行して結果をエクスポート

メンテナンス

• get_database_usage_info - 使用状況の統計を取得

• rescan_database_field_values - フィールド値を再スキャン

コア操作

• list_tables - フィルタリング付きでテーブルを一覧表示

• get_table - テーブルの詳細を取得

• update_table - テーブル設定を更新

• update_tables - テーブルを一括更新

データ操作

• get_table_data - テーブルデータを取得

• append_csv_to_table - CSVデータを追加

• replace_table_csv - CSVデータで置き換え

スキーマとリレーションシップ

• get_table_query_metadata - クエリメタデータを取得

• get_table_fks - 外部キーのリレーションシップを取得

• get_table_related - 関連テーブルを取得

• sync_table_schema - テーブルスキーマを同期

フィールド管理

• reorder_table_fields - フィールド表示の並び順を変更

• rescan_table_field_values - フィールド値を再スキャン

• discard_table_field_values - キャッシュされた値を破棄

カード統合

• get_card_table_fks - カードテーブルの外部キーを取得

• get_card_table_query_metadata - カードテーブルのメタデータを取得

コレクション

• list_collections - すべてのコレクションを一覧表示

• create_collection - 新しいコレクションを作成

• update_collection - コレクションを更新

• delete_collection - コレクションを削除

• get_collection_items - コレクション項目を取得

検索と発見

• search_content - すべてのコンテンツを横断検索

アクティビティと分析

• get_recent_views - 最近のアクティビティを取得

• get_popular_items - 人気のコンテンツを取得

プレイグラウンドリンク

• get_metabase_playground_link - インタラクティブなプレイグラウンドリンクを生成

🧪 開発

セットアップ

git clone https://github.com/CognitionAI/metabase-mcp-server.git
cd metabase-mcp-server
npm install

ビルド

npm run build

開発モード

npm run watch

デバッグ

デバッグにはMCP Inspectorを使用してください:

npm run inspector

🔍 認証のテスト

APIキー認証

1. METABASE_URLとMETABASE_API_KEYを設定

2. サーバーを起動し、ログに「Using Metabase API Key」と表示されることを確認

3. list_dashboardsツールでテスト

ユーザー名/パスワード認証

1. METABASE_API_KEYを設定解除

2. METABASE_URL、METABASE_USERNAME、METABASE_PASSWORDを設定

3. サーバーを起動し、ログに「Using username/password」と表示されることを確認

4. list_dashboardsツールでテスト

🐛 トラブルシューティング

よくある問題

認証エラー:

• Metabase URLにアクセスできることを確認してください

• Metabaseの管理者設定でAPIキーの有効性を確認してください

• ユーザー名/パスワードの認証情報が正しいことを確認してください

接続の問題:

• Metabaseインスタンスが実行中であることを確認してください

• ネットワーク接続を確認してください

• HTTPSを使用している場合はSSL証明書を確認してください

ツール実行エラー:

• ユーザー/APIキーのMetabase権限を確認してください

• 要求されたリソースが存在することを確認してください

• 詳細なエラーメッセージについてはサーバーログを確認してください

📄 ライセンス

このプロジェクトはMITライセンスの下でライセンスされています。詳細はLICENSEファイルを参照してください。

🤝 コントリビューション

コントリビューションを歓迎します！GitHubリポジトリにアクセスして、次のことができます:

• 🐛 バグを報告

• 💡 機能をリクエスト

• 🔧 プルリクエストを送信

• 📖 ドキュメントを改善

開発ガイドライン

1. リポジトリをフォーク

2. フィーチャーブランチを作成

3. テストを含めて変更を加える

4. すべてのテストが通ることを確認

5. プルリクエストを提出

🆘 サポート

• 📚 ドキュメント

• 🐛 Issueトラッカー

世界のために❤️を込めて作られました