Bigquery MCP Server

🚀 BigQuery MCP 服務器

BigQuery MCP 服務器是一個專門為大型語言模型（LLMs）訪問 Google BigQuery 而設計的數據服務器。它能助力用戶高效執行各類操作，如 SQL 查詢、數據集和表的管理等。下面將詳細介紹該服務器的各項功能、安裝步驟、配置方法以及使用示例。

✨ 主要特性

• 查詢工具：可執行 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

錯誤處理

服務器提供詳細的錯誤信息，包括：

• 認證失敗
• 權限問題
• 查詢語法錯誤
• 分區過濾器缺失
• 數據處理量過大請求

代碼結構

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    # 查詢驗證和響應格式化

💻 使用示例

基礎用法

查詢工具

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

📄 許可證

MIT