Quegenx Supabase MCP Server

🚀 Supabase MCP 服務端

Supabase MCP 服務端專為與 Cursor 和 Codeium 的 Composer 集成打造，能提供全面的數據庫管理功能，簡化數據庫操作流程，讓開發者更高效地進行數據庫管理。

🚀 快速開始

📦 安裝指南

按照以下步驟完成項目的安裝：

1. 克隆此倉庫到本地：

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

2. 進入項目目錄：

cd supabase-mcp-server

3. 安裝依賴項：

npm install

4. 編譯代碼：

npm run build

🚀 啟動服務

在編譯完成後，使用以下命令啟動 MCP 服務器：

node dist/index.js [postgresql://...] 

請將 [postgresql://...] 替換為你的 Supabase 數據庫連接字符串。

✨ 主要特性

此 MCP 服務器具備以下功能：

• 創建和刪除表
• 管理用戶數據
• 操作索引
• 執行 SQL 查詢
• 管理即時通信通道
• 用戶身份驗證

📁 項目結構

以下是項目的文件結構：

supabase-mcp-server/
├── dist/                    # 編譯後的 JavaScript 文件
│   ├── index.d.ts          # TypeScript 聲明文件
│   └── index.js            # 主 JavaScript 文件
├── src/                    # 源代碼
│   └── index.ts           # 主 TypeScript 文件
├── package.json           # 項目配置文件
├── package-lock.json      # 依賴鎖定文件
└── tsconfig.json         # TypeScript 配置文件

💻 使用示例

基礎用法

在 MCP 服務器運行後，你可以在 Cursor 的 Composer 中通過自然語言描述操作數據庫。例如：

• "顯示所有數據庫表"
• "創建一個包含 id、名稱和電子郵件字段的新用戶表"

高級用法

除了基本的 CRUD 操作外，該服務器還支持複雜的數據庫管理任務，如管理即時數據流、執行自定義 SQL 查詢、設置和修改用戶權限等。

🚀 主要優勢

• 直觀控制：通過自然語言處理技術，簡化數據庫操作流程。
• 全面覆蓋：涵蓋表、索引、函數、安全性等多個方面。
• 無縫集成：直接在 Cursor 和 Codeium 中使用。
• 開發者友好：減少在 IDE 和數據庫工具之間切換的麻煩。
• 安全可靠：確保數據庫訪問的安全性。

🛡️ 安全須知

⚠️ 重要提示

• 保護連接字符串，避免將敏感信息暴露在外。
• 進行權限管理，設置嚴格的訪問控制策略。
• 進行輸入驗證，防止 SQL 注入攻擊。

🚨 常見問題解決

1. 啟動失敗問題

• 確保 Node.js 已正確安裝並添加到 PATH 環境變量中。
• 檢查 package.json 和 package-lock.json 文件是否存在。

2. 連接數據庫失敗

• 確認數據庫服務是否運行且網絡可達。
• 驗證連接字符串的格式和信息是否正確。

🌟 貢獻指南

歡迎社區貢獻代碼！如需提交代碼或提出建議，請參考 CONTRIBUTING.md 文件。

📄 許可證

此項目遵循 MIT 協議。更多信息請查看 LICENSE 文件。