使用说明

项目简介

本项目提供了一种在macOS系统上使用Docker快速部署MCP服务器的方案，该服务器能够连接到您的Supabase PostgreSQL数据库，并允许您通过自然语言查询数据库。它简化了LLM应用访问和操作Supabase数据的流程，无需编写复杂的SQL语句。

主要功能点

快速部署： 通过Docker Compose一键部署MCP服务器和PostgreSQL数据库。
Supabase集成： 无缝连接到您的Supabase PostgreSQL数据库。
自然语言查询： 支持通过自然语言与数据库交互，简化数据访问。
MCP协议兼容： 作为一个MCP服务器，可以与任何兼容MCP协议的客户端进行通信。
本地自托管： 所有组件都可以在本地macOS环境中运行，方便开发和测试。

安装步骤

安装 Docker Desktop: 访问 Docker官网下载并安装 Docker Desktop for macOS。
创建 'docker-compose.yml' 文件: 在您希望存放项目的目录下，创建一个名为 'docker-compose.yml' 的文件，并将仓库提供的 'docker-compose.yml' 内容复制粘贴到该文件中。
配置数据库连接: 打开 'docker-compose.yml' 文件，替换以下占位符为您实际的 Supabase 数据库凭据：
- 'your_postgres_password': 替换为您的 PostgreSQL 数据库密码。
- 'your_database_name': 替换为您的数据库名称。
启动 Docker 容器: 打开终端，导航到 'docker-compose.yml' 文件所在的目录，运行命令 'docker-compose up -d'。
验证服务: 运行 'docker-compose ps' 命令，确认 'supabase-db' 和 'mcp-supabase' 容器的状态为 "Up"。

服务器配置

MCP客户端需要配置以下信息以连接到此MCP服务器：

{
  "serverName": "Supabase MCP Server",
  "command": "docker-compose",
  "args": [
    "up",
    "-d"
  ],
  "description": "启动基于Docker Compose的Supabase MCP服务器。请确保在docker-compose.yml文件所在目录下执行此命令。",
  "config": {
    "host": "http://localhost:3000"
  }
}

参数注释:

'serverName': 服务器的名称，可以自定义，用于在MCP客户端中标识该服务器。
'command': 启动服务器的命令，这里使用 'docker-compose' 命令。
'args': 启动命令的参数，'up -d' 表示使用 Docker Compose 启动并后台运行服务。
'description': 对该服务器配置的描述，方便用户理解其用途。
'config': 配置信息，包含连接服务器所需的参数。
- 'host': MCP 服务器的访问地址，默认为 'http://localhost:3000'。

注意: MCP客户端通常需要能够执行 'docker-compose' 命令的环境。在实际应用中，您可能需要根据您的部署环境调整启动命令和参数。

基本使用方法

启动 MCP 服务器后，您可以使用任何兼容 MCP 协议的客户端工具（如AI应用或自定义客户端）与服务器进行交互。
客户端需要配置上述提供的服务器配置信息，以连接到运行在 'http://localhost:3000' 的 MCP 服务器。
通过客户端，您可以发送自然语言查询，MCP 服务器会将查询转换为 SQL 语句并在 Supabase 数据库上执行，最终将结果返回给客户端。
您可以参考 MCP 协议的文档，了解如何定义和使用 Resources, Tools, 和 Prompts 来扩展服务器的功能。

关键词