使用说明

项目简介

BigQuery MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器，它允许大型语言模型 (LLM) 与 Google BigQuery 数据库进行交互。通过此服务器，LLM 可以执行 SQL 查询，检索数据表列表，并获取数据表的结构信息。

主要功能点

执行 SQL 查询 (execute-query): 允许 LLM 运行 BigQuery SQL 查询并获取结果。
列出数据表 (list-tables): 允许 LLM 获取指定 BigQuery 数据集或所有数据集中的数据表名称列表。
描述数据表 (describe-table): 允许 LLM 获取指定 BigQuery 数据表的结构定义 (DDL)。

安装步骤

通过 Smithery 安装 (推荐 Claude Desktop 用户): 如果您使用 Claude Desktop，可以通过 Smithery 命令行工具自动安装 BigQuery Server。打开终端并运行以下命令：

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

手动安装: 如果您不使用 Claude Desktop 或希望手动安装，请按照以下步骤操作：

克隆仓库到本地：

git clone https://github.com/LucasHild/mcp-server-bigquery

进入仓库目录：

cd mcp-server-bigquery

安装依赖：

uv sync

或者，如果您的环境中没有 'uv'，可以使用 'pip'：

pip install -r requirements.txt

服务器配置 (MCP 客户端配置)

您需要在 MCP 客户端（例如 Claude Desktop）中配置 BigQuery MCP Server 的连接信息。配置信息通常以 JSON 格式添加到客户端的配置文件中。

Claude Desktop 配置示例:

打开 Claude Desktop 的配置文件 'claude_desktop_config.json'，通常位于：

MacOS: '~/Library/Application\ Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%/Claude/claude_desktop_config.json'

在 'mcpServers' 字段中添加 'bigquery' 服务器的配置。

开发/未发布服务器配置示例:

"mcpServers": {
  "bigquery": {
    "command": "uv",
    "args": [
      "--directory",
      "{{PATH_TO_REPO}}",
      "run",
      "mcp-server-bigquery",
      "--project",
      "{{GCP_PROJECT_ID}}",
      "--location",
      "{{GCP_LOCATION}}"
    ]
  }
}

'server name': 'bigquery' (服务器名称，客户端用此名称引用)
'command': 'uv' (运行命令，'uv' 用于在项目目录中运行 Python 脚本)
'args': 命令参数列表
- '--directory': '"{{PATH_TO_REPO}}"' (指向仓库本地路径，请替换 '{{PATH_TO_REPO}}' 为实际路径)
- 'run mcp-server-bigquery': 运行 'mcp-server-bigquery' 脚本
- '--project': '"{{GCP_PROJECT_ID}}"' (您的 Google Cloud Project ID，请替换 '{{GCP_PROJECT_ID}}')
- '--location': '"{{GCP_LOCATION}}"' (您的 Google Cloud 区域，例如 'europe-west9'，请替换 '{{GCP_LOCATION}}')

已发布服务器配置示例:

"mcpServers": {
  "bigquery": {
    "command": "uvx",
    "args": [
      "mcp-server-bigquery",
      "--project",
      "{{GCP_PROJECT_ID}}",
      "--location",
      "{{GCP_LOCATION}}"
    ]
  }
}

'server name': 'bigquery'
'command': 'uvx' (运行已发布的可执行文件的命令，'uvx' 假设 'mcp-server-bigquery' 可执行文件已在系统 PATH 中)
'args': 命令参数列表 (与开发配置类似，但无需 '--directory' 和 'run')
- 'mcp-server-bigquery': 运行 'mcp-server-bigquery' 可执行文件
- '--project': '"{{GCP_PROJECT_ID}}"' (您的 Google Cloud Project ID，请替换 '{{GCP_PROJECT_ID}}')
- '--location': '"{{GCP_LOCATION}}"' (您的 Google Cloud 区域，例如 'europe-west9'，请替换 '{{GCP_LOCATION}}')

请根据您的实际情况选择合适的配置，并替换 '{{PATH_TO_REPO}}', '{{GCP_PROJECT_ID}}', 和 '{{GCP_LOCATION}}' 为您的实际值。

基本使用方法

确保 BigQuery MCP Server 已成功配置到您的 MCP 客户端中。
在 LLM 应用中，您可以指示 LLM 使用 'execute-query', 'list-tables', 或 'describe-table' 工具来访问和操作 BigQuery 数据。例如，您可以向 LLM 发出指令：“列出我的 BigQuery 数据集中的所有表” 或 “执行 SQL 查询来查找销售额最高的前 10 个产品”。
LLM 将调用相应的工具，BigQuery MCP Server 将执行请求并将结果返回给 LLM。

注意: 您需要确保配置的 Google Cloud Project ID 和 Location 是正确的，并且您的环境已配置访问 BigQuery 的权限。

关键词

使用说明

信息