Bigquery MCP Server

🚀 BigQuery MCP サーバー

BigQuery MCP サーバーは、大規模言語モデル（LLMs）が Google BigQuery にアクセスするためのデータサーバーです。このドキュメントでは、このサーバーの機能、インストール手順、設定方法、および使用例について詳しく説明します。

🚀 クイックスタート

このセクションでは、BigQuery MCP サーバーの基本的な使い方を説明します。まずはインストールから始めましょう。

✨ 主な機能

• クエリツール：SQL クエリを実行し、結果を返します。
• すべてのデータセットをリストするツール：指定されたプロジェクト内のすべてのデータセットを返します。
• すべてのテーブルをリストするツール：指定されたデータセット ID に基づいて、そのデータセット内のすべてのテーブルを返します。
• テーブル情報を取得するツール：指定されたデータセットとテーブル ID に基づいて、テーブルのメタデータとオプションのパーティション情報を返します。
• クエリのコストを見積もるツール：クエリの実行コストを見積もり、処理されるバイト数と推定費用を含みます。

📦 インストール

1. リポジトリをクローンする

   git clone https://github.com/your-repository.git
   cd bigquery-mcp-server
   

2. 依存関係をインストールする npm または yarn を使用してインストールします：

   npm install
   # または
   yarn install
   

3. プロジェクトをビルドする

   npm run build
   # または
   yarn build
   

4. サーバーを起動する ビルドが完了したら、メインファイルを実行してサーバーを起動します：

   node dist/index.js
   

📚 ドキュメント

設定

環境変数

src/utils/args-parser.ts では、以下の環境変数が定義されています：

• BIGQUERY_PROJECT_ID：Google Cloud プロジェクト ID（必須）
• BIGQUERY_KEY_FILE：サービスアカウントのキーファイルのパス（オプション）
• BIGQUERY_LOCATION：BigQuery の地理位置（デフォルト：asia - northeast1）

設定ファイル

ルートディレクトリに .env ファイルを作成し、以下の内容を記述できます：

BIGQUERY_PROJECT_ID=your_project_id
BIGQUERY_KEY_FILE=/path/to/service-account-key.json
BIGQUERY_LOCATION=asia-northeast1

💻 使用例

クエリツール

{
  "query": "SELECT * FROM `project.dataset.table` LIMIT 10",
  "maxResults": 100
}

すべてのデータセットをリストするツール

// パラメータは不要

すべてのテーブルをリストするツール

{
  "datasetId": "your_dataset"
}

テーブル情報を取得するツール

{
  "datasetId": "your_dataset",
  "tableId": "your_table",
  "partition": "20250101"
}

クエリのコストを見積もるツール

{
  "query": "SELECT * FROM `project.dataset.table` WHERE date = '2025-01-01'"
}

🔧 技術詳細

エラー処理

サーバーは、以下を含む詳細なエラー情報を提供します：

• 認証失敗
• 権限問題
• クエリ構文エラー
• パーティションフィルターの欠如
• データ処理量が多すぎる要求

コード構造

src/
├── index.ts              # エントリーファイル
├── server.ts             # BigQueryMcpServer クラス
├── types.ts              # 型定義
├── tools/                # ツールの実装
│   ├── query.ts          # クエリツール
│   ├── list-datasets.ts  # すべてのデータセットをリストするツール
│   ├── list-tables.ts    # すべてのテーブルをリストするツール
│   ├── table-info.ts     # テーブル情報を取得するツール
│   └── dry-run.ts        # クエリのコストを見積もるツール
└── utils/                # ユーティリティ関数
    ├── args-parser.ts    # コマンドライン引数パーサー
    └── query-utils.ts    # クエリの検証と応答のフォーマット

📄 ライセンス

MIT