使用说明

项目简介

'supabase-nextjs-mcp-server' 是一个基于 Model Context Protocol (MCP) 的服务器,旨在为大型语言模型 (LLM) 应用提供与 Supabase 数据库交互的能力。它通过 MCP 协议标准化的工具接口,允许 LLM 安全地查询、插入、更新和删除 Supabase 数据库中的数据,从而扩展 LLM 的数据访问和操作能力。

主要功能点

  • Supabase 数据访问: 提供工具让 LLM 可以直接与 Supabase 数据库进行交互,包括查询数据、新增记录、修改记录和删除记录。
  • 工具注册与执行: 实现了 'query_data', 'insert_record', 'update_record', 'delete_record' 等工具,LLM 可以调用这些工具来操作 Supabase 数据库。
  • JSON-RPC 通信: 使用标准的 JSON-RPC 协议与 MCP 客户端通信,确保与各种支持 MCP 协议的 LLM 应用兼容。

安装步骤

  1. 环境准备: 确保已安装 Node.js 和 npm。
  2. 克隆仓库: 将仓库克隆到本地:
    git clone https://github.com/tengfone/supabase-nextjs-mcp-server
  3. 进入目录: 进入项目仓库目录:
    cd supabase-nextjs-mcp-server
  4. 安装依赖: 安装项目依赖:
    npm install
  5. 构建项目: 构建服务器代码:
    npm run build
  6. 配置环境变量: 配置 Supabase 连接所需的 'NEXT_PUBLIC_SUPABASE_URL' 和 'NEXT_PUBLIC_SUPABASE_ANON_KEY' 环境变量。你需要从你的 Supabase 项目设置中获取这些密钥。

服务器配置

要将此 MCP 服务器配置到 MCP 客户端(例如 Claude Desktop),你需要提供服务器的启动命令。以下是配置示例(JSON 格式):

{
  "mcpServers": {
    "supabase-nextjs-server": {
      "command": "/path/to/supabase-nextjs-server/build/index.js"
    }
  }
}
  • 'mcpServers': 定义 MCP 服务器配置的对象。
  • 'supabase-nextjs-server': 你为该服务器指定的名称,可以自定义。这个名称将用于在 MCP 客户端中标识和引用该服务器。
  • 'command': MCP 服务器的启动命令,指向构建后 'index.js' 文件的绝对路径。你需要将 '/path/to/supabase-nextjs-server' 替换为你本地仓库的实际存储路径。

请注意,'args' 字段在此配置中为空,因为该服务器的启动命令本身已包含了所有必要的启动逻辑。

基本使用方法

  1. 启动服务器: 在仓库根目录下,运行构建后的 'build/index.js' 文件来启动 MCP 服务器。服务器将通过 stdio 与 MCP 客户端通信。
  2. 配置客户端: 在支持 MCP 协议的 LLM 客户端中,根据上述 “服务器配置” 部分的说明,添加并配置 'supabase-nextjs-server'。
  3. LLM 调用工具: 配置完成后,LLM 客户端即可通过 MCP 协议调用 'supabase-nextjs-server' 提供的工具,例如指示 LLM 使用 'query_data' 工具查询 Supabase 数据库中的特定表格数据。

信息

分类

数据库与文件