MCP Server Spanner

🚀 Spanner用MCPサーバー

Spanner用MCPサーバーは、Google Cloud Spannerデータベースに接続し、SQLクエリを実行するModel Context Protocol (MCP) サーバーです。主に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）を実行

📚 ドキュメント

環境変数

開発者向け情報

devcontainerでの環境構築

このリポジトリはdevcontainer環境での開発をサポートしています。VSCodeを使用してこのリポジトリをクローンし、コンテナを開いてください。 devcontainerコンテナは自動的にSpannerエミュレータ、インスタンス、およびデータベースを構成します。

Inspectorの使用

シェルで以下のコマンドを実行します。

# 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

📄 ライセンス

プロジェクトリポジトリ内のライセンスファイルを参照してください。