🚀 Supabase MCP 服务端
Supabase MCP 服务端专为与 Cursor 和 Codeium 的 Composer 集成打造，能提供全面的数据库管理功能，简化数据库操作流程，让开发者更高效地进行数据库管理。
🚀 快速开始
📦 安装指南
按照以下步骤完成项目的安装：
- 克隆此仓库到本地：
git clone https://github.com/Quegenx/supabase-mcp-server.git
- 进入项目目录：
cd supabase-mcp-server
- 安装依赖项：
npm install
- 编译代码：
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 文件。