Supabase MCP

🚀 Supabase MCP 服務器

Supabase MCP 服務器是一個用於與 Supabase 數據庫交互的工具，基於 Model Context Protocol (MCP) 構建。它能讓你通過 MCP 接口輕鬆查詢數據庫表，併為數據庫生成 TypeScript 類型，提升開發效率。

🚀 快速開始

要使用 Supabase MCP 服務器，你需要先完成安裝和配置。以下是詳細步驟：

安裝

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"
}

✨ 主要特性

• 查詢表格：對任何表格執行查詢，支持：

  • 模式選擇
  • 列過濾
  • Where 子句（帶多個操作符）
  • 分頁
  • 錯誤處理

• 類型生成：為您的數據庫生成 TypeScript 類型：

  • 支持任意模式（公共、認證、API 等）
  • 適用於本地和遠程 Supabase 項目
  • 直接輸出到控制檯
  • 自動檢測項目引用

💻 使用示例

基礎用法

查詢表格

使用 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 文件。