MCP ExplorerExplorer

BigQuery

@erguton 13 days ago
85ย MIT
FreeCommunity
Databases
#BigQuery#AI#LLM
Server implementation for Google BigQuery integration that enables direct BigQuery database access and querying capabilities

Overview

What is BigQuery

This is a server designed to facilitate natural language interactions between LLMs, like Claude, and BigQuery data. It acts as a secure intermediary that translates user queries into database commands, allowing users to query data conversationally without needing to write SQL.

Use cases

Users can engage in natural language conversations to extract insights from their BigQuery data, such as identifying top customers, summarizing data trends, or exploring dataset schemas. The tool streamlines data analysis by enabling non-technical users to interact with databases through simple questions.

How to use

To use the server, you need to set up authentication, configure it with your Google Cloud project and BigQuery location, and integrate it with Claude Desktop. You can either use a quick install method via Smithery or manually configure your claude_desktop_config.json file before starting interactions with your data.

Key features

The server allows users to run SQL queries through plain English queries, access tables and materialized views, analyze datasets within a 1GB limit, and maintains read-only secure access to data. It also provides labeled schemas for better understanding of dataset types.

Where to use

This server is primarily designed for use with Claude Desktop, which is currently the only supported LLM interface. It is suitable in environments where users need to fetch insights from BigQuery databases regularly and prefer conversational interfaces over traditional querying methods.

Content

BigQuery MCP Server

smithery badge

BigQuery MCP Server Logo

What is this? ๐Ÿค”

This is a server that lets your LLMs (like Claude) talk directly to your BigQuery data! Think of it as a friendly translator that sits between your AI assistant and your database, making sure they can chat securely and efficiently.

Quick Example

You: "What were our top 10 customers last month?"
Claude: *queries your BigQuery database and gives you the answer in plain English*

No more writing SQL queries by hand - just chat naturally with your data!

How Does It Work? ๐Ÿ› ๏ธ

This server uses the Model Context Protocol (MCP), which is like a universal translator for AI-database communication. While MCP is designed to work with any AI model, right now itโ€™s available as a developer preview in Claude Desktop.

Hereโ€™s all you need to do:

  1. Set up authentication (see below)
  2. Add your project details to Claude Desktopโ€™s config file
  3. Start chatting with your BigQuery data naturally!

What Can It Do? ๐Ÿ“Š

  • Run SQL queries by just asking questions in plain English
  • Access both tables and materialized views in your datasets
  • Explore dataset schemas with clear labeling of resource types (tables vs views)
  • Analyze data within safe limits (1GB query limit by default)
  • Keep your data secure (read-only access)

Quick Start ๐Ÿš€

Prerequisites

  • Node.js 14 or higher
  • Google Cloud project with BigQuery enabled
  • Either Google Cloud CLI installed or a service account key file
  • Claude Desktop (currently the only supported LLM interface)

Option 1: Quick Install via Smithery (Recommended)

To install BigQuery MCP Server for Claude Desktop automatically via Smithery, run this command in your terminal:

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

The installer will prompt you for:

  • Your Google Cloud project ID
  • BigQuery location (defaults to us-central1)

Once configured, Smithery will automatically update your Claude Desktop configuration and restart the application.

Option 2: Manual Setup

If you prefer manual configuration or need more control:

  1. Authenticate with Google Cloud (choose one method):

    • Using Google Cloud CLI (great for development):
      gcloud auth application-default login
      
    • Using a service account (recommended for production):
      # Save your service account key file and use --key-file parameter
      # Remember to keep your service account key file secure and never commit it to version control
      
  2. Add to your Claude Desktop config
    Add this to your claude_desktop_config.json:

    • Basic configuration:

      {
        "mcpServers": {
          "bigquery": {
            "command": "npx",
            "args": [
              "-y",
              "@ergut/mcp-bigquery-server",
              "--project-id",
              "your-project-id",
              "--location",
              "us-central1"
            ]
          }
        }
      }
    • With service account:

      {
        "mcpServers": {
          "bigquery": {
            "command": "npx",
            "args": [
              "-y",
              "@ergut/mcp-bigquery-server",
              "--project-id",
              "your-project-id",
              "--location",
              "us-central1",
              "--key-file",
              "/path/to/service-account-key.json"
            ]
          }
        }
      }
  3. Start chatting!
    Open Claude Desktop and start asking questions about your data.

Command Line Arguments

The server accepts the following arguments:

  • --project-id: (Required) Your Google Cloud project ID
  • --location: (Optional) BigQuery location, defaults to โ€˜us-central1โ€™
  • --key-file: (Optional) Path to service account key JSON file

Example using service account:

npx @ergut/mcp-bigquery-server --project-id your-project-id --location europe-west1 --key-file /path/to/key.json

Permissions Needed

Youโ€™ll need one of these:

  • roles/bigquery.user (recommended)
  • OR both:
    • roles/bigquery.dataViewer
    • roles/bigquery.jobUser

Developer Setup (Optional) ๐Ÿ”ง

Want to customize or contribute? Hereโ€™s how to set it up locally:

# Clone and install
git clone https://github.com/ergut/mcp-bigquery-server
cd mcp-bigquery-server
npm install

# Build
npm run build

Then update your Claude Desktop config to point to your local build:

{
  "mcpServers": {
    "bigquery": {
      "command": "node",
      "args": [
        "/path/to/your/clone/mcp-bigquery-server/dist/index.js",
        "--project-id",
        "your-project-id",
        "--location",
        "us-central1",
        "--key-file",
        "/path/to/service-account-key.json"
      ]
    }
  }
}

Current Limitations โš ๏ธ

  • MCP support is currently only available in Claude Desktop (developer preview)
  • Connections are limited to local MCP servers running on the same machine
  • Queries are read-only with a 1GB processing limit
  • While both tables and views are supported, some complex view types might have limitations

Support & Resources ๐Ÿ’ฌ

License ๐Ÿ“

MIT License - See LICENSE file for details.

Author โœ๏ธ

Salih Ergรผt

Sponsorship

This project is proudly sponsored by:

Version History ๐Ÿ“‹

See CHANGELOG.md for updates and version history.

Tools

query
Run a read-only BigQuery SQL query

Comments