MCPcopy
hub / github.com/googleapis/mcp-toolbox

github.com/googleapis/mcp-toolbox @v1.6.0 sqlite

repository ↗ · DeepWiki ↗ · release v1.6.0 ↗
7,499 symbols 29,529 edges 906 files 1,498 documented · 20%
README

logo

MCP Toolbox for Databases

googleapis%2Fmcp-toolbox | Trendshift

Go Report Card License: Apache
2.0 Docs Discord Medium

Python SDK JS/TS SDK Go SDK Java SDK

MCP Toolbox for Databases is an open source Model Context Protocol (MCP) server that connects your AI agents, IDEs, and applications directly to your enterprise databases.

architecture

It serves a dual purpose: 1. Ready-to-use MCP Server (Build-Time): Instantly connect Gemini CLI, Google Antigravity, Claude Code, Codex, or other MCP clients to your databases using our prebuilt generic tools. Talk to your data, explore schemas, and generate code without writing boilerplate. 2. Custom Tools Framework (Run-Time): A robust framework to build specialized, highly secure AI tools for your production agents. Define structured queries, semantic search, and NL2SQL capabilities safely and easily.

This README provides a brief overview. For comprehensive details, see the full documentation.

[!IMPORTANT]
Repository Name Update: The genai-toolbox repository has been officially renamed to mcp-toolbox. To ensure your local environment reflects the new name, you may update your remote: git remote set-url origin https://github.com/googleapis/mcp-toolbox.git

[!NOTE] This solution was originally named “Gen AI Toolbox for Databases” (github.com/googleapis/genai-toolbox) as its initial development predated MCP, but was renamed to align with the MCP compatibility.

Table of Contents


Why MCP Toolbox?

  • Out-of-the-Box Database Access: Prebuilt generic tools for instant data exploration (e.g., list_tables, execute_sql) directly from your IDE or CLI.
  • Custom Tools Framework: Build production-ready tools with your own predefined logic, ensuring safety through Restricted Access, Structured Queries, and Semantic Search.
  • Simplified Development: Integrate tools into your Agent Development Kit (ADK), LangChain, LlamaIndex, or custom agents in less than 10 lines of code.
  • Better Performance: Handles connection pooling, integrated auth (IAM), and end-to-end observability (OpenTelemetry) out of the box.
  • Enhanced Security: Integrated authentication for more secure access to your data.
  • End-to-end Observability: Out of the box metrics and tracing with built-in support for OpenTelemetry.

Quick Start: Prebuilt Tools

Stop context-switching and let your AI assistant become a true co-developer. By connecting your IDE to your databases with MCP Toolbox, you can query your data in plain English, automate schema discovery and management, and generate database-aware code.

You can use the Toolbox in any MCP-compatible IDE or client (e.g., Gemini CLI, Google Antigravity, Claude Code, Codex, etc.) by configuring the MCP server.

Prebuilt tools are also conveniently available via the Google Antigravity MCP Store with a simple click-to-install experience.

  1. Add the following to your client's MCP configuration file (usually mcp.json or claude_desktop_config.json):

    json { "mcpServers": { "toolbox-postgres": { "command": "npx", "args": [ "-y", "@toolbox-sdk/server", "--prebuilt=postgres", "--stdio" ] } } }

  2. Set the appropriate environment variables to connect, see the Prebuilt Tools Reference.

When you run Toolbox with a --prebuilt=<database> flag, you instantly get access to standard tools to interact with that database. You can also specify a specific toolset using the --prebuilt=<database>/<toolset> syntax (e.g., --prebuilt=postgres/data to only load SQL tools).

Supported databases currently include: - Google Cloud: AlloyDB, BigQuery, Cloud SQL (PostgreSQL, MySQL, SQL Server), Spanner, Firestore, Knowledge Catalog (formerly known as Dataplex). - Other Databases: PostgreSQL, MySQL, MariaDB, SQL Server, Oracle, MongoDB, Redis, Elasticsearch, CockroachDB, ClickHouse, Couchbase, Neo4j, Snowflake, Trino, and more.

For a full list of available tools and their capabilities across all supported databases, see the Prebuilt Tools Reference.

See the Install & Run the Toolbox server section for different execution methods like Docker or binaries.

[!TIP] For users looking for a managed solution, Google Cloud MCP Servers provide a managed MCP experience with prebuilt tools; you can learn more about the differences here.


Quick Start: Custom Tools

Toolbox can also be used as a framework for customized tools. The primary way to configure Toolbox is through the tools.yaml file. If you have multiple files, you can tell Toolbox which to load with the --config tools.yaml flag.

You can find more detailed reference documentation to all resource types in the Resources.

Sources

The sources section of your tools.yaml defines what data sources your Toolbox should have access to. Most tools will have at least one source to execute against.

kind: source
name: my-pg-source
type: postgres
host: 127.0.0.1
port: 5432
database: toolbox_db
user: toolbox_user
password: my-password

For more details on configuring different types of sources, see the Sources.

Tools

The tools section of a tools.yaml define the actions an agent can take: what type of tool it is, which source(s) it affects, what parameters it uses, etc.

kind: tool
name: search-hotels-by-name
type: postgres-sql
source: my-pg-source
description: Search for hotels based on name.
parameters:
  - name: name
    type: string
    description: The name of the hotel.
statement: SELECT * FROM hotels WHERE name ILIKE '%' || $1 || '%';

For more details on configuring different types of tools, see the Tools.

Toolsets

The toolsets section of your tools.yaml allows you to define groups of tools that you want to be able to load together. This can be useful for defining different groups based on agent or application.

kind: toolset
name: my_first_toolset
tools:
    - my_first_tool
    - my_second_tool
---
kind: toolset
name: my_second_toolset
tools:
    - my_second_tool
    - my_third_tool

Prompts

The prompts section of a tools.yaml defines prompts that can be used for interactions with LLMs.

kind: prompt
name: code_review
description: "Asks the LLM to analyze code quality and suggest improvements."
messages:
  - content: >
         Please review the following code for quality, correctness,
         and potential improvements: \n\n{{.code}}
arguments:
  - name: "code"
    description: "The code to review"

For more details on configuring prompts, see the Prompts.


Install & Run the Toolbox server

You can run Toolbox directly with a configuration file:

npx @toolbox-sdk/server --config tools.yaml

This runs the latest version of the Toolbox server with your configuration file.

[!NOTE] This method is optimized for convenience rather than performance. For a more standard and reliable installation, please use the binary or container image as described in Install & Run the Toolbox server.

Install Toolbox

For the latest version, check the releases page and use the following instructions for your OS and CPU architecture.

Binary

To install Toolbox as a binary:

Linux (AMD64)

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

```sh

see releases page for other versions

export VERSION=1.6.0 curl -L -o toolbox https://storage.googleapis.com/mcp-toolbox-for-databases/v$VERSION/linux/amd64/toolbox chmod +x toolbox ```

macOS (Apple Silicon)

To install Toolbox as a binary on macOS (Apple Silicon):

```sh

see releases page for other versions

export VERSION=1.6.0 curl -L -o toolbox https://storage.googleapis.com/mcp-toolbox-for-databases/v$VERSION/darwin/arm64/toolbox chmod +x toolbox ```

macOS (Intel)

To install Toolbox as a binary on macOS (Intel):

```sh

see releases page for other versions

export VERSION=1.6.0 curl -L -o toolbox https://storage.googleapis.com/mcp-toolbox-for-databases/v$VERSION/darwin/amd64/toolbox chmod +x toolbox ```

Windows (Command Prompt)

To install Toolbox as a binary on Windows (Command Prompt):

cmd :: see releases page for other versions set VERSION=1.6.0 curl -o toolbox.exe "https://storage.googleapis.com/mcp-toolbox-for-databases/v%VERSION%/windows/amd64/toolbox.exe"

Windows (PowerShell)

To install Toolbox as a binary on Windows (PowerShell):

```powershell

see releases page for other versions

$VERSION = "1.6.0" curl.exe -o toolbox.exe "https://storage.googleapis.com/mcp-toolbox-for-databases/v$VERSION/windows/amd64/toolbox.exe" ```

Windows ARM64 (Command Prompt)

To install Toolbox as a binary on Windows ARM64 (Command Prompt):

cmd :: see releases page for other versions set VERSION=1.6.0 curl -o toolbox.exe "https://storage.googleapis.com/mcp-toolbox-for-databases/v%VERSION%/windows/arm64/toolbox.exe"

Windows ARM64 (PowerShell)

To install Toolbox as a binary on Windows ARM64 (PowerShell):

```powershell

see releases page for other versions

$VERSION = "1.6.0" curl.exe -o toolbox.exe "https://storage.googleapis.com/mcp-toolbox-for-databases/v$VERSION/windows/arm64/toolbox.exe" ```

Container image

You can also install Toolbox as a container:

# see releases page for other versions
export VERSION=1.6.0
docker pull us-central1-docker.pkg.dev/database-toolbox/toolbox/toolbox:$VERSION

Homebrew

To install Toolbox using Homebrew on macOS or Linux:

brew install mcp-toolbox

Compile from source

To install from source, ensure you have the latest version of Go installed, and then run the following command:

go install github.com/googleapis/mcp-toolbox@v1.6.0

Gemini CLI

Check out the Gemini CLI extensions to install prebuilt tools for specific databases like AlloyDB, BigQuery, and Cloud SQL directly into Gemini CLI.

# Install Gemini CLI
npm install -g @google/gemini-cli
# Install the extension
gemini extensions install https://github.com/gemini-cli-extensions/cloud-sql-postgres
# Run Gemini CLI
gemini

Interact with your custom tools using natural language through the Gemini CLI.

```sh

Install the extension

ge

Extension points exported contracts — how you extend this code

SourceProvider (Interface)
SourceProvider defines the minimal view of the server.ResourceManager that the Tool package needs. This is implemented t [23 …
internal/tools/tools.go
SourceConfig (Interface)
SourceConfig is the interface for configuring a source. [47 implementers]
internal/sources/sources.go
AuthServiceConfig (Interface)
AuthServiceConfig is the interface for configuring authentication services. [4 implementers]
internal/auth/auth.go
Logger (Interface)
Logger is the interface used throughout the project for logging. [3 implementers]
internal/log/logger.go
ToolboxError (Interface)
ToolboxError is the interface all custom errors must satisfy [2 implementers]
internal/util/errors.go
EmbeddingModelConfig (Interface)
EmbeddingModelConfig is the interface for configuring embedding models. [1 implementers]
internal/embeddingmodels/embeddingmodels.go
ProgressToken (Interface)
ProgressToken is used to associate progress notifications with the original request.
internal/server/mcp/jsonrpc/jsonrpc.go
PromptConfigFactory (FuncType)
PromptConfigFactory defines the signature for a function that creates and decodes a specific prompt's configuration.
internal/prompts/prompts.go

Core symbols most depended-on inside this repo

NewStringParameter
called by 874
internal/util/parameters/parameters.go
Error
called by 755
internal/util/errors.go
NewClientServerError
called by 594
internal/util/errors.go
NewAgentError
called by 543
internal/util/errors.go
FormatYaml
called by 443
internal/testutils/testutils.go
UnmarshalResourceConfig
called by 442
internal/server/config.go
Unmarshal
called by 426
internal/util/util.go
String
called by 377
internal/tools/neo4j/neo4jschema/types/types.go

Shape

Method 3,153
Function 2,876
Struct 1,117
Interface 286
TypeAlias 40
FuncType 23
Class 4

Languages

Go99%
TypeScript1%
Python1%

Modules by API surface

internal/util/parameters/parameters.go141 symbols
tests/tool.go65 symbols
internal/tools/tools.go58 symbols
internal/tools/looker/lookerconversationalanalytics/lookerconversationalanalytics.go57 symbols
tests/option.go44 symbols
internal/sources/bigquery/bigquery.go43 symbols
tests/bigquery/bigquery_integration_test.go41 symbols
internal/sources/cloudhealthcare/cloud_healthcare.go41 symbols
internal/util/util.go38 symbols
internal/tools/bigquery/bigqueryconversationalanalytics/bigqueryconversationalanalytics.go38 symbols
tests/common.go34 symbols
internal/sources/dataplex/dataplex.go33 symbols

Dependencies from manifests, versioned

cel.dev/exprv0.25.1 · 1×
cloud.google.com/gov0.123.0 · 1×
cloud.google.com/go/aiplatformv1.109.0 · 1×
cloud.google.com/go/alloydbv1.26.0 · 1×
cloud.google.com/go/alloydbconnv1.18.4 · 1×
cloud.google.com/go/authv0.20.0 · 1×
cloud.google.com/go/auth/oauth2adaptv0.2.8 · 1×
cloud.google.com/go/bigqueryv1.77.0 · 1×
cloud.google.com/go/bigtablev1.50.0 · 1×
cloud.google.com/go/cloudsqlconnv1.22.0 · 1×
cloud.google.com/go/compute/metadatav0.9.0 · 1×

Datastores touched

(mysql)Database · 1 repos
(mongodb)Database · 1 repos
dbnameDatabase · 1 repos
database_nameDatabase · 1 repos
defaultdbDatabase · 1 repos
mydbDatabase · 1 repos

For agents

$ claude mcp add mcp-toolbox \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact