Supabase MCP Server Zdf

🚀 Supabase MCP 服務器

Supabase MCP（管理控制平面）服務器是一款用於通過 Cursor 的 Composer 和 Codeium 的 Cascade 進行數據庫管理的工具。它提供了一套完整的數據庫管理功能，涵蓋表、記錄、索引、函數、安全性等方面，還支持自然語言控制，極大提升了數據庫管理的便捷性。

🚀 快速開始

Supabase MCP 服務器可幫助你藉助自然語言指令，在 Cursor 的 Composer 和 Codeium 的 Cascade 中輕鬆管理 Supabase 數據庫。以下為你介紹啟動使用的基本步驟。

✨ 主要特性

核心功能

• 自然語言控制：通過簡單的對話指令管理您的 Supabase 數據庫。
• 全面覆蓋：涵蓋表、記錄、索引、函數、安全性等全方位數據庫管理工具。
• 無縫集成：直接在 Cursor 的 Composer 和 Codeium 的 Cascade 中使用。

具體功能

表管理

• 顯示所有表
• 創建新表
• 刪除表
• 修改表結構

記錄管理

• 插入記錄
• 查詢記錄
• 更新記錄
• 刪除記錄

索引管理

• 添加索引
• 刪除索引
• 修改索引

函數與存儲過程

• 創建函數
• 刪除函數
• 調用函數

安全性

• 管理用戶權限
• 設置訪問控制
• 審計日誌

📦 安裝指南

項目結構

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

安裝步驟

1. 克隆倉庫：

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

2. 安裝依賴：

npm install

3. 編譯項目：

npm run build

📚 詳細文檔

配置指南

啟動服務器

1. 確保您已經安裝了 Node.js 和 npm。
2. 在項目根目錄中運行以下命令啟動服務器：

node dist/index.js [connection-string]

示例連接字符串

postgresql://[email]:password@localhost:5432/dbname

配置環境變量

您可以將數據庫連接信息存儲在環境變量中：

export DB_USER='your-database-user'
export DB_PASSWORD='your-database-password'
export DB_HOST='localhost'
export DB_PORT=5432
export DB_NAME='your-database-name'

node dist/index.js

使用指南

配置 MCP 服務器

1. 在 Cursor 的 Composer 中，進入 MCP 設置。
2. 添加一個新的 MCP 提供程序：
   • 名稱：Supabase Database
   • 類型：Executable
   • 命令：node dist/index.js
   • 參數：--connection-string [email]:password@localhost:5432/dbname

啟動服務器（可選）

如果您希望在本地啟動 MCP 服務器，可以運行以下命令：

node dist/index.js --start-server

安全注意事項

1. 保持數據庫連接字符串的安全
2. 避免將敏感憑證提交到版本控制系統中
3. 使用適當的身份驗證和授權策略
4. 對所有輸入進行有效的驗證和清理，以防止 SQL 注入

故障排除

常見連接問題

1. Node.js 路徑問題

   • 確保使用正確的 Node.js 路徑
   • 在 Mac/Linux 上：使用 which node 獲取正確路徑
   • 在 Windows 上：使用 where node 獲取正確路徑
   • 將 /usr/local/bin/node 替換為您實際的 Node.js 路徑

2. 文件路徑問題

   • 使用絕對路徑而不是相對路徑
   • 在 Mac/Linux 上：在項目目錄中使用 pwd 獲取完整路徑
   • 在 Windows 上：使用 cd 獲取完整路徑
   • 示例：/Users/username/projects/supabase-mcp-server/dist/index.js

3. MCP 未檢測到工具

   • 點擊 Cursor 的 MCP 設置中的刷新按鈕
   • 確保服務器正在運行且沒有錯誤信息
   • 檢查連接字符串是否正確
   • 驗證您的 Supabase 憑證

4. 端口衝突

   • 確保使用的端口未被其他應用程序佔用
   • 嘗試使用不同的端口

日誌與調試

1. 啟用詳細日誌記錄：

DEBUG=* node dist/index.js

2. 檢查服務器輸出以獲取更多信息。

高級功能

自動化腳本

您可以編寫自動化腳本來執行復雜的數據庫任務，例如：

• 數據遷移
• 備份與恢復
• 性能監控

擴展插件

社區提供多種擴展插件，增強功能，例如：

• 圖形化界面
• 集成其他服務
• 自定義命令

最佳實踐

1. 定期備份：確保數據庫的定期備份以防萬一。
2. 訪問控制：嚴格限制對數據庫的訪問權限。
3. 監控性能：持續監控數據庫性能，及時優化。
4. 更新依賴：定期檢查並更新項目依賴，以獲取最新功能和安全補丁。

社區與支持

論壇與討論組

• Supabase 論壇
• Cursor 討論組

文檔與教程

• 官方文檔
• 學習教程

貢獻與開發

如何貢獻

1. 提交問題與建議：
   • 倉庫：GitHub 問題跟蹤
2. 提交拉取請求：
   • Fork 倉庫
   • 提交更改
   • 創建拉取請求

開發指南

1. 克隆倉庫並初始化子模塊：

git clone https://github.com/Quegenx/supabase-mcp-server.git
cd supabase-mcp-server
git submodule update --init --recursive

2. 安裝依賴：

npm install

3. 啟動開發服務器：

npm run dev

📄 許可證

項目在 MIT 許可證下發布，允許自由使用、修改和分發。

通過 Supabase MCP 服務器，您可以更高效地管理您的數據庫，享受集成的開發體驗。如需進一步瞭解，請參考官方文檔或加入社區討論。