MCP Server Spanner

🚀 適用於Spanner的模型上下文協議服務器

適用於Spanner的模型上下文協議服務器（MCP Server for Spanner）是一個支持Model Context Protocol（MCP）的服務器，它能夠連接到Google Cloud Spanner數據庫並執行SQL查詢。該服務器主要用於實現AI助手等工具與Spanner數據庫之間的交互，為數據操作提供了便利。

🚀 快速開始

MCP Server for Spanner 可幫助你輕鬆連接 Google Cloud Spanner 數據庫並執行各類 SQL 查詢。以下將為你詳細介紹其安裝和使用方法。

✨ 主要特性

• 查詢執行：支持執行 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）

📚 詳細文檔

環境變量

開發人員信息

在 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

📄 許可證

請參考項目倉庫中的許可證文件。