Supabase MCP

🚀 Supabase MCP サーバー

Supabase データベースと相互作用するための Model Context Protocol (MCP) サーバーです。このサーバーは、MCP インターフェースを通じてテーブルをクエリし、TypeScript 型を生成するツールを提供します。

✨ 主な機能

• テーブルクエリ：任意のテーブルに対してクエリを実行でき、以下の機能をサポートします。

  • スキーマ選択
  • 列フィルタリング
  • Where 句（複数の演算子をサポート）
  • ページング
  • エラー処理

• 型生成：データベース用の TypeScript 型を生成します。

  • 任意のスキーマ（public、auth、API など）をサポート
  • ローカルおよびリモートの Supabase プロジェクトに対応
  • コンソールに直接出力
  • プロジェクトリファレンスを自動検出

📦 インストール

前提条件

1. Node.js (v16 以上)
2. Supabase プロジェクト（ローカルまたはホスティング）
3. Supabase CLI（型生成用）

手順

1. リポジトリをクローンします。

git clone https://github.com/yourusername/supabase-mcp-server.git
cd supabase-mcp-server

2. 依存関係をインストールします。

npm install

3. Supabase CLI（型生成用）をインストールします。

# npm を使用する場合
npm install -g supabase

# macOS の Homebrew を使用する場合
brew install supabase/tap/supabase

🔧 設定

1. Supabase の資格情報を取得します。

   • ホスティングされたプロジェクトの場合：
     • URL からプロジェクトリファレンスを抽出します（例：prj-123456789abcdef0）。
     • anon キーではなく、関連するサービスロールキーを使用します。
   • ローカルプロジェクトの場合：
     • ローカルの Supabase インスタンスが実行中であることを確認します。
     • サービスロールキーが正しいことを検証します。

2. config.json という名前のファイルを作成し、以下の内容を追加します。

{
  "supabaseUrl": "your-supabase-url",
  "supabaseAnonKey": "your-supabase-anon-key"
}

💻 使用例

基本的な使用法

テーブルクエリ

XML 形式を使用してクエリを行います。

<query>
  <table>users</table>
  <columns>
    <column>id</column>
    <column>username</column>
    <column>email</column>
  </columns>
  <where>
    <condition>active = true</condition>
  </where>
</query>

型生成

以下のコマンドを使用して TypeScript 型を生成します。

npx supabase generate --schema public --output ./types

トラブルシューティング

型生成の問題

1. Supabase CLI がインストールされていることを確認します。

supabase --version

2. ローカルプロジェクトの場合：

   • ローカルの Supabase インスタンスが実行中であることを確認します。
   • サービスロールキーが正しいことを検証します。

3. ホスティングされたプロジェクトの場合：

   • URL からプロジェクトリファレンスが正しく抽出されていることを確認します。
   • anon キーではなく、サービスロールキーを使用していることを確認します。

クエリの問題

1. スキーマとテーブル名の正確性を確認します。
2. 選択と Where 句の列名を検証します。
3. サービスロールキーが必要な権限を持っていることを確認します。

コントリビューションガイド

1. リポジトリをフォークします。

git fork https://github.com/yourusername/supabase-mcp-server.git

2. 機能ブランチを作成します。

git checkout -b feature/my-feature

3. 変更をコミットします。

git commit -m '添加我的功能'

4. ブランチにプッシュします。

git push origin feature/my-feature

5. プルリクエストを送信します。

📄 ライセンス

MIT License - 詳細は LICENSE ファイルを参照してください。