Supabase PostgreSQL

🚀 如何設置和使用 Supabase MCP 服務器

本項目提供了一個 MCP（機器控制協議）服務器，可藉助 Cursor 和 Codeium Cascade 對 Supabase 數據庫進行管理。通過該服務器，你能夠使用自然語言命令執行各類數據庫操作。

🚀 快速開始

安裝依賴

1. 克隆本倉庫：

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

2. 安裝所有依賴項：

npm install

3. 構建項目：

npm run build

配置

1. 複製你的 Supabase 項目 ID 和 Anon 公共密鑰。

2. 創建一個 .env 文件：

echo "SUPABASE_PROJECT_ID=your_project_id" > .env
echo "SUPABASE_PUBLIC_KEY=your_anon_key" >> .env

3. 啟動服務器：

npm start

✨ 主要特性

配置完成後，MCP 服務器會在 Cursor 的 Composer 中提供所有數據庫管理工具。你只需描述想要對數據庫執行的操作，AI 就會使用合適的命令來執行。

示例：

• 📋 "顯示我數據庫中的所有表"
• ➕ "創建一個包含 id、name 和 email 列的新用戶表"
• 🔍 "在 users 表的 email 列上添加索引"

📦 安裝指南

安裝依賴

1. 克隆本倉庫：

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

2. 安裝所有依賴項：

npm install

3. 構建項目：

npm run build

配置

1. 複製你的 Supabase 項目 ID 和 Anon 公共密鑰。

2. 創建一個 .env 文件：

echo "SUPABASE_PROJECT_ID=your_project_id" > .env
echo "SUPABASE_PUBLIC_KEY=your_anon_key" >> .env

3. 啟動服務器：

npm start

💻 使用示例

基礎用法

配置完成後，MCP 服務器將在 Cursor 的 Composer 中提供所有數據庫管理工具。只需描述你想要對數據庫進行的操作，AI 將會使用適當的命令執行。

示例：

• 📋 "顯示我數據庫中的所有表"
• ➕ "創建一個包含 id、name 和 email 列的新用戶表"
• 🔍 "在 users 表的 email 列上添加索引"

📚 詳細文檔

項目結構

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

平臺特定說明

Windows 用戶

• 確保安裝了 Node.js
• 使用命令行運行命令
• 複製 .env 文件到項目根目錄

macOS 和 Linux 用戶

• 確保你使用的是最新版本的 Node.js
• 可以使用 xdg-open 或 open 打開生成的日誌文件：

xdg-open ./logs/server.log

🔧 技術細節

故障排除

環境變量問題

• 確保你已經正確設置了 SUPABASE_PROJECT_ID 和 SUPABASE_PUBLIC_KEY。
• 檢查 .env 文件是否存在，並且沒有拼寫錯誤。

連接問題

• 確保你的網絡允許出站到 Supabase 服務（默認端口：443）
• 使用 curl https://api.supabase.com/v1/anon 測試連接

啟動問題

npm start -- --env development

如果需要調試，可以使用以下命令：

DEBUG=supabase-mcp:* npm start

安全注意事項

• 🔐 保持你的數據庫連接字符串安全
• ⚠️ 永遠不要將敏感憑證提交到版本控制系統
• 👮 使用適當的訪問控制和權限
• 🛡️ 驗證和清理所有輸入以防止 SQL 注入

📄 許可證

MIT License

📞 聯繫方式

有問題或建議？請在 GitHub Issues 中創建一個問題。