Supabase MCP

🚀 Supabase-MCP 使用指南

Supabase-MCP 是一個功能強大的程序，可幫助用戶輕鬆進行數據庫操作、文件存儲、邊緣函數調用和用戶管理等。以下將詳細介紹其安裝、配置、使用方法等內容。

🚀 快速開始

📦 安裝指南

要安裝此程序，請執行以下命令：

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