MCP Server for Spanner

MCP Server for Spanner

MCP Server for Spanner 是一个 Model Context Protocol (MCP) 服务，用于连接 Google Cloud Spanner 数据库并执行 SQL 查询。它主要作为 AI 助手等与 Spanner 数据库交互的工具。

功能

• 执行 SELECT 查询
• 执行数据更新（INSERT、UPDATE、DELETE）查询
• 执行 DDL（CREATE TABLE、ALTER TABLE 等）查询
• 获取表列表
• 显示表结构详情

安装

前提条件

• Node.js 22 或更高版本
• 可使用 Spanner 模拟器或 devcontainer 的环境

设置

# リポジトリのクローン
git clone <repository-url>
cd mcp-server-spanner

# 依存関係のインストール
npm install

# TypeScriptのビルド
npm run build

注：目前，此工具仅支持连接 Spanner 模拟器。

使用方法

按照 MCP 服务的一般启动方法操作。 这里列出具体的使用示例，包括在 Claude Desktop 中使用，以及使用开发用 MCP Inspector 的方法。

在 Claude Desktop 中配置（Mac/Linux）

请参照 Claude Desktop 的配置，编辑以下配置中的 Spanner 模拟器连接信息部分并添加配置。

    "spanner": {
      "command": "bash",
      "args": [
        "YOUR_LOCAL_REPOSITORY_ROOT/bin/mcp-server-spanner",
        "--project-id=YOUR_PROJECT_ID",
        "--instance-id=YOUR_INSTANCE_ID",
        "--database-id=YOUR_DATABASE_ID",
        "--api-endpoint=localhost:9010"
      ],
    }

之后，请重启 Claude Desktop。

提供的工具

作为 MCP 服务，提供以下工具：

1. read_query：执行 SELECT 查询
2. list_tables：获取数据库的表列表
3. describe_table：显示指定表的结构
4. execute_ddl：执行 DDL 查询
5. execute_write：执行更新类（INSERT、UPDATE、DELETE）查询

环境变量

环境变量	说明	默认值
PROJECT_ID	Google Cloud 项目 ID	dev-project
INSTANCE_ID	Spanner 实例 ID	dev-instance
DATABASE_ID	Spanner 数据库 ID	dev-database
API_ENDPOINT	Spanner API 端点（用于模拟器）	spanner-emulator:9010
SPANNER_EMULATOR_HOST	Spanner 模拟器的主机	（根据 API_ENDPOINT 自动设置）

开发者信息

使用 devcontainer 构建环境

本仓库支持使用 devcontainer 进行开发。 在 VSCode 中克隆本仓库后，请在容器中打开。

devcontainer 会自动设置容器、Spanner 模拟器、实例和数据库。

使用 Inspector

在 shell 中运行以下命令。

# MCPプロトコル形式でサーバーを起動
npm run inspect

可以通过环境变量指定所用 Spanner 模拟器的端点：

# 環境変数で接続情報を指定する例
export PROJECT_ID=your-project-id
export INSTANCE_ID=your-instance-id
export DATABASE_ID=your-database-id
export API_ENDPOINT=localhost:9010
npm run inspect

许可证

MIT