本页面介绍如何使用 MCP Toolbox for Databases 从集成式开发环境 (IDE) 创建和管理 AlloyDB for PostgreSQL 集群和实例。您可以使用支持 Model Context Protocol (MCP) 的开发者工具。
Model Context Protocol (MCP) 是一种开放协议,用于将大语言模型 (LLM) 连接到数据源和 AlloyDB API 等 API。AI 助理是 IDE 中依托 LLM 的聊天界面,可帮助您实现目标并完成任务。本页介绍如何使用 MCP Toolbox for Databases 通过以下 IDE 将开发者助理工具公开给 AlloyDB 实例:
- Cursor
- Windsurf (Codium)
- Visual Studio Code (Copilot)
- Cline(VS Code 扩展程序)
- Claude Desktop
- Claude code
- Gemini CLI
- Gemini Code Assist
准备工作
在 Google Cloud 控制台的项目选择器页面上,选择或创建 Google Cloud 项目。
确保您的 Google Cloud 项目已启用结算功能。 了解如何检查项目是否已启用结算功能。
启用 AlloyDB Admin API。
所需的角色
如需管理 AlloyDB 资源,请让管理员向您授予项目的以下 Identity and Access Management 角色:
- AlloyDB Admin (
roles/alloydb.admin
)。 - Service Usage Consumer (
roles/serviceusage.serviceUsageConsumer
)。
安装 MCP Toolbox
以二进制文件形式下载最新版本的 MCP Toolbox。选择与您的操作系统 (OS) 和 CPU 架构对应的二进制文件。您必须使用 MCP Toolbox V0.10.0 版或更高版本。
linux/amd64
curl -O https://storage.googleapis.com/genai-toolbox/v0.10.0/linux/amd64/toolbox
darwin/arm64
curl -O https://storage.googleapis.com/genai-toolbox/v0.10.0/darwin/arm64/toolbox
darwin/amd64
curl -O https://storage.googleapis.com/genai-toolbox/v0.10.0/darwin/amd64/toolbox
windows/amd64
curl -O https://storage.googleapis.com/genai-toolbox/v0.10.0/windows/amd64/toolbox
将该二进制文件设为可执行文件。
chmod +x toolbox
验证安装。
./toolbox --version
配置 MCP 客户端
您可以将 IDE 配置为使用控制平面工具来创建和管理 AlloyDB 集群及实例。如果您已有 AlloyDB 实例,请跳过此步骤,前往使用 MCP Toolbox 将 IDE 连接到 AlloyDB for PostgreSQL。使用给定的控制平面工具创建具有公共 IP 地址的实例。将以下配置添加到 IDE 的 MCP 设置文件中。此方法会将 alloydb-postgres-admin
工具公开给 AI 助理。
Claude Code
- 安装 Claude Code。
- 在项目根目录中创建
.mcp.json
文件(如果尚不存在)。 - 运行
gcloud auth print-access-token
以生成用作API_KEY
的访问令牌。
- 添加以下配置,将
API_KEY
替换为生成的令牌,然后保存。
{ "mcpServers": { "alloydb-admin": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt", "alloydb-postgres-admin", "--stdio"], "env": { "API_KEY": "API_KEY" } } } }
Claude Desktop
- 打开 Claude Desktop,然后前往设置。
- 在开发者标签页中,点击修改配置以打开配置文件。
- 运行
gcloud auth print-access-token
以生成用作API_KEY
的访问令牌。
- 添加以下配置,将
API_KEY
替换为生成的令牌,然后保存。
{ "mcpServers": { "alloydb-admin": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt", "alloydb-postgres-admin", "--stdio"], "env": { "API_KEY": "API_KEY" } } } }
Cline
- 在 VS Code 中打开 Cline 扩展程序,然后点按 MCP 服务器图标。
- 点按“配置 MCP 服务器”以打开配置文件。
- 运行
gcloud auth print-access-token
以生成用作API_KEY
的访问令牌。
- 添加以下配置,将
API_KEY
替换为生成的令牌,然后保存。
{ "mcpServers": { "alloydb-admin": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt", "alloydb-postgres-admin", "--stdio"], "env": { "API_KEY": "API_KEY" } } } }
光标
- 在项目根目录中创建
.cursor
目录(如果尚不存在)。 - 创建
.cursor/mcp.json
文件(如果尚不存在)并打开该文件。 - 运行
gcloud auth print-access-token
以生成用作API_KEY
的访问令牌。
- 添加以下配置,将
API_KEY
替换为生成的令牌,然后保存:
{ "mcpServers": { "alloydb-admin": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt", "alloydb-postgres-admin", "--stdio"], "env": { "API_KEY": "API_KEY" } } } }
Visual Studio Code (Copilot)
- 打开 VS Code,并在项目根目录中创建
.vscode
目录(如果尚不存在)。 - 创建
.vscode/mcp.json
文件(如果尚不存在)并打开该文件。 - 运行
gcloud auth print-access-token
以生成用作API_KEY
的访问令牌。
- 添加以下配置,将
API_KEY
替换为生成的令牌,然后保存。
{ "servers": { "alloydb-admin": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt", "alloydb-postgres-admin", "--stdio"], "env": { "API_KEY": "API_KEY" } } } }
Windsurf
- 打开 Windsurf 并前往 Cascade 助理。
- 点击 MCP 图标,然后点击配置以打开配置文件。
- 运行
gcloud auth print-access-token
以生成用作API_KEY
的访问令牌。
- 添加以下配置,将
API_KEY
替换为生成的令牌,然后保存。
{ "mcpServers": { "alloydb-admin": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt", "alloydb-postgres-admin", "--stdio"], "env": { "API_KEY": "API_KEY" } } } }
Gemini CLI
- 安装 Gemini CLI。
- 在工作目录中,创建一个名为
.gemini
的文件夹。在该文件夹中,创建一个settings.json
文件。 - 运行
gcloud auth print-access-token
以生成用作API_KEY
的访问令牌。
- 添加以下配置,将
API_KEY
替换为生成的令牌,然后保存。
{ "mcpServers": { "alloydb-admin": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt", "alloydb-postgres-admin", "--stdio"], "env": { "API_KEY": "API_KEY" } } } }
Gemini Code Assist
- 在 Visual Studio Code 中安装 Gemini Code Assist 扩展程序。
- 在 Gemini Code Assist 对话中启用智能体模式。
- 在工作目录中,创建一个名为
.gemini
的文件夹。在该文件夹中,创建一个settings.json
文件。 - 运行
gcloud auth print-access-token
以生成用作API_KEY
的访问令牌。
- 添加以下配置,将
API_KEY
替换为生成的令牌,然后保存:
{ "mcpServers": { "alloydb-admin": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt", "alloydb-postgres-admin", "--stdio"], "env": { "API_KEY": "API_KEY" } } } }
您的 AI 工具现在已使用 MCP 连接到 AlloyDB for PostgreSQL 控制平面。让 AI 助理创建集群或实例。
使用管理员工具
LLM 可使用以下工具:
- alloydb-create-cluster:创建 AlloyDB 集群。
- alloydb-create-instance:创建 AlloyDB 实例(
PRIMARY
、READ_POOL
或SECONDARY
)。 - alloydb-create-user:为 AlloyDB 集群创建
ALLOYDB_BUILT_IN
或基于IAM
的用户。 - alloydb-get-operation:轮询 Operations API,直到操作完成。
- alloydb-list-clusters:列出给定项目和位置中的集群。
- alloydb-list-instances:列出给定项目和位置中的实例。
- alloydb-list-users:列出给定项目和位置中的用户。
连接到您的数据
设置 AlloyDB 集群和实例后,您可以将 IDE 连接到数据库以查询数据。如需了解详情,请参阅使用 MCP Toolbox 将 IDE 连接到 AlloyDB。