Supabase MCP

🚀 Supabase-MCPの使用ガイド

このプログラムは、Supabaseを使用したデータベース操作やファイルストレージ操作、ユーザー管理などを行うための便利なツールです。以下に、インストール方法、設定方法、使用方法などを詳しく説明します。

🚀 クイックスタート

📦 インストール

このプログラムをインストールするには、以下のコマンドを実行します。

npm install supabase-mcp

⚙️ 設定

supabase-mcp.config.jsまたは.envという名前の設定ファイルを作成し、以下の内容を追加します。

// または .env ファイル:
# Supabase プロジェクト ID を設定
SUPABASE_PROJECT_ID=your_project_id
# Supabase アノンキーを設定
SUPABASE_ANON_KEY=your_anon_key

💻 使用例

基本的な使用法

データベース操作

データのクエリ

{
  table: "users",
  columns: ["id", "email", "created_at"],
  where?: Record<string, any>
}

例:

{
  table: "posts",
  columns: ["id", "title", "content"],
  where: { published: true }
}

データの挿入

{
  table: "users",
  data: {
    email: "user@example.com",
    password: "securepassword"
  }
}

例:

{
  table: "posts",
  data: {
    title: "Hello World",
    content: "This is my first post.",
    user_id: 1
  }
}

データの更新

{
  table: "users",
  data: {
    password: "newsecurepassword"
  },
  where: { email: "user@example.com" }
}

例:

{
  table: "posts",
  data: { status: "draft" },
  where: { id: 1 }
}

データの削除

{
  table: "users",
  where: { email: "user@example.com" }
}

例:

{
  table: "posts",
  where: { status: "deleted" }
}

ファイルストレージ操作

ファイルのアップロード

{
  bucket: "uploads",
  path: "images/avatar.jpg",
  file: selectedFile,
  options?: {
    cacheControl?: string;
    contentType?: string;
    upsert?: boolean;
  };
}

例:

{
  bucket: "documents",
  path: "reports/2023.pdf",
  file: fileObject,
  options: {
    contentType: "application/pdf",
    upsert: true
  }
}

ファイルのダウンロード

{
  bucket: "uploads",
  path: "images/avatar.jpg"
}

例:

{
  bucket: "downloads",
  path: "files/report.docx"
}

エッジ関数の呼び出し

関数の呼び出し

{
  function: "processData",
  params?: {
    key: string,
    value: any
  }[]
}

例:

{
  function: "calculateTotal",
  params: [
    { key: "amount", value: 100 },
    { key: "taxRate", value: 0.15 }
  ]
}

ユーザー管理

ユーザーの作成

{
  email: "newuser@example.com",
  password: "securepassword"
}

例:

{
  email: "admin@example.com",
  password: "adminsecure"
}

高度な使用法

エラー処理

プログラムが返すエラー情報には、以下の内容が含まれる場合があります。

• code: エラーコード
• message: エラーの説明
• stack?: string：エラーのスタックトレース（ある場合）

例:

{
  code: "AUTHENTICATION_FAILED",
  message: "Invalid API key provided."
}

🔧 開発

テストの実行

テストを実行するには、以下のコマンドを実行します。

npm test supabase-mcp

プロジェクトのビルド

プロジェクトをビルドするには、以下のコマンドを実行します。

npm run build

コード規約のチェック

コード規約をチェックするには、以下のコマンドを実行します。

npm run lint

🤝 貢献ガイド

このプロジェクトに貢献したい場合は、以下の手順に従ってください。

1. このリポジトリをフォークします。
2. 新しいブランチを作成します: git checkout -b feature/your-feature
3. 変更をコミットします: git commit -m "add your feature"
4. フォークしたリポジトリにプッシュします: git push origin feature/your-feature
5. メインブランチに対してプルリクエストを作成します。

📄 ライセンス

このプロジェクトは MIT License の下でライセンスされています。

🛠️ サポート

何か問題がある場合は、以下の方法でサポートチームに連絡してください。

• メールアドレス: support@supabase-mcp.com
• 電話番号: +1 (555) 123-4567