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 服务器，您可以更高效地管理您的数据库，享受集成的开发体验。如需进一步了解，请参考官方文档或加入社区讨论。