mirror of https://github.com/googleapis/genai-toolbox.git synced 2026-01-09 07:28:05 -05:00

Files

Anubhav Dhawan 05799475b4 docs: update antigravity docs installation instructions and prerequisites (#2088 )

This PR updates the documentation across the repository to reflect the
new installation workflow using `npx` and Node.js, replacing the
previous binary download instructions. It also standardizes the
prerequisites and adds helpful configuration notes for Windows users.

These changes simplify the setup process for users by leveraging `npx`
for executing the tools, ensuring they always use the latest version
without manual binary management. It also addresses feedback from PR
#2079 regarding installation clarity and Windows support.

---------

Co-authored-by: Twisha Bansal <twishabansal07@gmail.com>

2025-12-02 12:25:31 -08:00

3.4 KiB

Raw Permalink Blame History

Cloud Spanner MCP Server

The Cloud Spanner Model Context Protocol (MCP) Server gives AI-powered development tools the ability to work with your Google Cloud Spanner databases. It supports executing SQL queries and exploring schemas.

Features

An editor configured to use the Cloud Spanner MCP server can use its AI capabilities to help you:

Query Data - Execute DML and DQL SQL queries
Explore Schema - List tables and view schema details

Prerequisites

Node.js installed.
A Google Cloud project with the Cloud Spanner API enabled.
Ensure Application Default Credentials are available in your environment.
IAM Permissions:
- Cloud Spanner Database User (roles/spanner.databaseUser) (for data access)
- Cloud Spanner Viewer (roles/spanner.viewer) (for schema access)

Install & Configuration

In the Antigravity MCP Store, click the "Install" button.
Add the required inputs for your instance in the configuration pop-up, then click "Save". You can update this configuration at any time in the "Configure" tab.

You'll now be able to see all enabled tools in the "Tools" tab.

Note

If you encounter issues with Windows Defender blocking the execution, you may need to configure an allowlist. See Configure exclusions for Microsoft Defender Antivirus for more details.

Usage

Once configured, the MCP server will automatically provide Cloud Spanner capabilities to your AI assistant. You can:

"Execute a DML query to update customer names."
"List all tables in the my-database."
"Execute a DQL query to select data from orders table."

Server Capabilities

The Cloud Spanner MCP server provides the following tools:

Tool Name	Description
`execute_sql`	Use this tool to execute DML SQL.
`execute_sql_dql`	Use this tool to execute DQL SQL.
`list_tables`	Lists detailed schema information for user-created tables.
`list_graphs`	Lists detailed graph schema information for user-created graphs.

Custom MCP Server Configuration

The MCP server is configured using environment variables.

export SPANNER_PROJECT="<your-gcp-project-id>"
export SPANNER_INSTANCE="<your-spanner-instance-id>"
export SPANNER_DATABASE="<your-spanner-database-id>"
export SPANNER_DIALECT="googlesql" # Optional: "googlesql" or "postgresql". Defaults to "googlesql".

Add the following configuration to your MCP client (e.g., settings.json for Gemini CLI, mcp_config.json for Antigravity):

{
  "mcpServers": {
    "spanner": {
      "command": "npx",
      "args": ["-y", "@toolbox-sdk/server", "--prebuilt", "spanner", "--stdio"],
      "env": {
        "SPANNER_PROJECT": "your-project-id",
        "SPANNER_INSTANCE": "your-instance-id",
        "SPANNER_DATABASE": "your-database-name",
        "SPANNER_DIALECT": "googlesql"
      }
    }
  }
}

Documentation

For more information, visit the Cloud Spanner documentation.

3.4 KiB Raw Permalink Blame History