Supabase MCP Server

Supabase MCP Server

site icon
2024.12.13 10
JavaScript数据库管理TypeScript类型生成数据库开发效率
Supabase-MCP是一个基于Model Context Protocol (MCP)的服务器,用于与Supabase数据库进行交互。它提供了查询表和生成TypeScript类型的功能,支持多种操作符和条件查询,适用于需要高效管理和操作Supabase数据库的开发场景。
View on GitHub

Overview

基本能力

产品定位

Supabase-MCP是一个专为Supabase数据库设计的MCP服务器,旨在通过MCP接口提供高效的数据库查询和类型生成功能。

核心功能

  • 查询表:支持对任何表执行查询,包括模式选择、列过滤、多操作符的where子句、分页和错误处理。
  • 类型生成:为数据库生成TypeScript类型,支持任何模式(public, auth, api等),适用于本地和远程Supabase项目。

适用场景

  • 开发者在开发过程中需要快速查询和操作Supabase数据库。
  • 需要为Supabase数据库生成TypeScript类型以提高开发效率的场景。

工具列表

  • query_table:查询特定表,支持模式选择和where子句。
  • generate_types:为Supabase数据库模式生成TypeScript类型。

常见问题解答

  • 类型生成问题:确保Supabase CLI已安装,本地Supabase实例正在运行,或使用的service_role键正确。
  • 查询问题:检查模式和表名,验证列名,确保service_role键具有必要的权限。

使用教程

使用依赖

  1. Node.js (v16或更高版本)
  2. Supabase项目(本地或托管)
  3. Supabase CLI(用于类型生成)

安装教程

  1. 克隆仓库:
git clone https://github.com/yourusername/supabase-mcp-server.git
cd supabase-mcp-server
  1. 安装依赖:
npm install
  1. 安装Supabase CLI:
npm install -g supabase
# 或在macOS上使用Homebrew
brew install supabase/tap/supabase

调试方式

  1. 配置环境变量:
echo "SUPABASE_URL=your_project_url
SUPABASE_KEY=your_service_role_key" > .env
  1. 构建服务器:
npm run build
  1. 集成到Claude Desktop或VSCode扩展中,按照README中的配置步骤进行。

许可证

该项目遵循 MIT 开源许可条款。