Supabase MCP

🚀 Supabase MCP 服务器

Supabase MCP 服务器是一个用于与 Supabase 数据库交互的工具，基于 Model Context Protocol (MCP) 构建。它能让你通过 MCP 接口轻松查询数据库表，并为数据库生成 TypeScript 类型，提升开发效率。

🚀 快速开始

要使用 Supabase MCP 服务器，你需要先完成安装和配置。以下是详细步骤：

安装

1. 克隆仓库：

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

2. 安装依赖项：

npm install

3. 安装 Supabase CLI（用于类型生成）：

# 使用 npm
npm install -g supabase

# 或使用 macOS 的 Homebrew
brew install supabase/tap/supabase

配置

1. 获取您的 Supabase 凭据：

   • 对于托管项目：
     • 从 URL 提取项目引用（例如：prj-123456789abcdef0）
     • 使用关联的服务角色密钥，而非 anon 密钥
   • 对于本地项目：
     • 确保本地 Supabase 实例正在运行
     • 验证服务角色密钥是否正确

2. 创建一个名为 config.json 的文件，并添加以下内容：

{
  "supabaseUrl": "your-supabase-url",
  "supabaseAnonKey": "your-supabase-anon-key"
}

✨ 主要特性

• 查询表格：对任何表格执行查询，支持：

  • 模式选择
  • 列过滤
  • Where 子句（带多个操作符）
  • 分页
  • 错误处理

• 类型生成：为您的数据库生成 TypeScript 类型：

  • 支持任意模式（公共、认证、API 等）
  • 适用于本地和远程 Supabase 项目
  • 直接输出到控制台
  • 自动检测项目引用

💻 使用示例

基础用法

查询表格

使用 XML 格式进行查询：

<query>
  <table>users</table>
  <columns>
    <column>id</column>
    <column>username</column>
    <column>email</column>
  </columns>
  <where>
    <condition>active = true</condition>
  </where>
</query>

生成类型

使用以下命令生成 TypeScript 类型：

npx supabase generate --schema public --output ./types

📚 详细文档

故障排除

类型生成问题

1. 确保安装了 Supabase CLI：

supabase --version

2. 对于本地项目：

   • 确保本地 Supabase 实例正在运行
   • 验证服务角色密钥是否正确

3. 对于托管项目：

   • 确认项目引用从 URL 正确提取
   • 确保使用的是服务角色密钥，而非 anon 密钥

查询问题

1. 检查模式和表名的准确性
2. 验证选择和 WHERE 子句中的列名
3. 确保服务角色密钥具有必要的权限

贡献指南

1. 叉仓库：

   git fork https://github.com/yourusername/supabase-mcp-server.git
   

2. 创建功能分支：

   git checkout -b feature/my-feature
   

3. 提交更改：

   git commit -m '添加我的功能'
   

4. 推送到分支：

   git push origin feature/my-feature
   

5. 提交拉取请求

📄 许可证

本项目采用 MIT 许可证，详细信息见 LICENSE 文件。