Files
genai-toolbox/docs/CLOUDSQLMSSQLADMIN_README.md
Averi Kitsch 86f374c631 docs: update Antigravity docs (#2025)
## Description

> Should include a concise description of the changes (bug or feature),
it's
> impact, along with a summary of the solution

## PR Checklist

> Thank you for opening a Pull Request! Before submitting your PR, there
are a
> few things you can do to make sure it goes smoothly:

- [ ] Make sure you reviewed

[CONTRIBUTING.md](https://github.com/googleapis/genai-toolbox/blob/main/CONTRIBUTING.md)
- [ ] Make sure to open an issue as a

[bug/issue](https://github.com/googleapis/genai-toolbox/issues/new/choose)
  before writing your code! That way we can discuss the change, evaluate
  designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
- [ ] Make sure to add `!` if this involve a breaking change

🛠️ Fixes #<issue_number_goes_here>

---------

Co-authored-by: prernakakkar-google <158031829+prernakakkar-google@users.noreply.github.com>
2025-11-25 19:26:15 +00:00

4.6 KiB

Cloud SQL for SQL Server Admin MCP Server

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

Features

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

  • Provision & Manage Infrastructure - Create and manage Cloud SQL instances and users

To connect to the database to explore and query data, search the MCP store for the Cloud SQL for SQL Server MCP Server.

Prerequisites

  • Download and install MCP Toolbox:

    1. Download the Toolbox binary: Download the latest binary for your operating system and architecture from the storage bucket. Check the releases page for additional versions:

      • To install Toolbox as a binary on Linux (AMD64):

        curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/linux/amd64/toolbox
        
      • To install Toolbox as a binary on macOS (Apple Silicon):

        curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/darwin/arm64/toolbox
        
      • To install Toolbox as a binary on macOS (Intel):

        curl -L -o toolbox https://storage.googleapis.com/genai-toolbox/v0.21.0/darwin/amd64/toolbox
        
      • To install Toolbox as a binary on Windows (AMD64):

        curl -o toolbox.exe "https://storage.googleapis.com/genai-toolbox/v0.21.0/windows/amd64/toolbox.exe"
        
    2. Make it executable:

      chmod +x toolbox
      
    3. Add the binary to $PATH in .~/bash_profile (Note: You may need to restart Antigravity for changes to take effect.):

      export PATH=$PATH:path/to/folder
      

      On Windows, move binary to the WindowsApps\ folder:

      move "C:\Users\<path-to-binary>\toolbox.exe" "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\"
      

      Tip: Ensure the destination folder for your binary is included in your system's PATH environment variable. To check PATH, use echo $PATH (or echo %PATH% on Windows).

  • A Google Cloud project with the Cloud SQL Admin API enabled.

  • Ensure Application Default Credentials are available in your environment.

  • IAM Permissions:

  • Cloud SQL Viewer (roles/cloudsql.viewer)

  • Cloud SQL Admin (roles/cloudsql.admin)

Install & Configuration

  1. In the Antigravity MCP Store, click the "Install" button.

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

Usage

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

  • "Create a new Cloud SQL for SQL Server instance named 'e-commerce-prod' in the 'my-gcp-project' project."
  • "Create a new user named 'analyst' with read access to all tables."

Server Capabilities

The Cloud SQL for SQL Server MCP server provides the following tools:

Tool Name Description
create_instance Create an instance (PRIMARY, READ-POOL, or SECONDARY).
create_user Create BUILT-IN or IAM-based users for an instance.
get_instance Get details about an instance.
get_user Get details about a user in an instance.
list_instances List instances in a given project and location.
list_users List users in a given project and location.
wait_for_operation Poll the operations API until the operation is done.

Custom MCP Server Configuration

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

{
  "mcpServers": {
    "cloud-sql-sqlserver-admin": {
      "command": "toolbox",
      "args": ["--prebuilt", "cloud-sql-mssql-admin", "--stdio"]
    }
  }
}

Documentation

For more information, visit the Cloud SQL for SQL Server documentation.