使用说明
Supabase MCP服务器
一个用于Supabase的强大的模型上下文协议(MCP)服务器, 建于 mcp使用。此服务器提供交互式工具和漂亮的React小部件,用于探索和查询您的Supabase数据库。
🚀 使用mcp构建
此MCP服务器由以下设备供电 mcp使用,一个用于构建MCP服务器的现代框架,具有:
- 创建类型安全的服务器 -构建完全支持TypeScript的MCP服务器
- React小部件支持 -使用OpenAI Apps SDK创建交互式UI组件
- 简化客户端连接 -无需LangChain即可轻松连接到其他MCP服务器
- 内置开发工具 -热重载、构建和部署命令
- 零样板 -专注于你的工具,而不是基础设施
特性
- 🔍 数据库架构资源管理器 -使用交互式UI浏览Supabase数据库中的所有表
- 📊 表格查看器 -使用漂亮的数据表小部件显示和浏览表数据
- 🔎 SQL查询执行器 -运行只读SQL查询并在交互式小部件中查看结果
- 🎨 React小部件 -使用React和Tailwind CSS构建的丰富交互式UI组件
- 🔐 安全认证 -使用Supabase个人访问令牌进行安全访问
先决条件
- Node.js 18+和yarn
- Supabase项目
- 一种Supabase个人访问令牌(在此处生成一个)
安装
# Install dependencies
yarn install
配置
设置以下所需的环境变量:
# Required: Your Supabase Personal Access Token
export ACCESS_TOKEN="your-access-token"
# Required: Content Security Policy URLs for widget loading => required by ChatGPT
export CSP_URLS="https://supabase.com,https://mcp.supabase.com,https://*.mcp-use.com,https://*.supabase.co"
发展
mcp使用 提供方便的开发命令:
# Start development server with hot reload
yarn dev
# Build for production
yarn build
# Start production server
yarn start
# Deploy the server
yarn deploy
可用工具
list-tables
列出Supabase数据库中的所有表。打开交互式模式资源管理器小部件。
参数:
schemas(可选):要包含的架构名称数组(默认值:["public"])
小装置: schema-explorer -带有模式信息的交互式表浏览器
show-table
显示特定表中的数据。打开数据表查看器小部件。
参数:
tableName(必填):要显示的表的名称schema(可选):架构名称(默认值:"public")limit(可选):要获取的最大行数(默认值:100)
小装置: table-viewer -具有排序和过滤功能的交互式数据表
execute-sql
在Supabase数据库上执行只读SQL查询。打开查询结果小部件。
参数:
query(必填):要执行的SQL查询
小装置: query-results -带语法高亮显示的交互式查询结果查看器
可用资源
supabase://project-url
获取您的Suabase项目的API URL。
UI控件
此服务器包括三个自定义React小部件 mcp使用:
- 架构资源管理器 (
schema-explorer)-浏览数据库表和模式 - 表格查看器 (
table-viewer)-查看和浏览表格数据 - 查询结果 (
query-results)-显示SQL查询结果
所有小部件都是用以下组件构建的:
- 反应19
- Tailwind CSS
- Radix UI组件
- Lucide React图标
建筑
此服务器展示了 mcp使用:
- 服务器端:用途
mcp-use/server创建工具、资源和小部件 - 客户端:用途
mcp-use/client连接到Supabase的官方MCP服务器 - 无郎链:直接MCP客户端连接,无需外部依赖
- 类型安全:Zod模式完全支持TypeScript
项目结构
.
├── index.ts # Main server file using [mcp-use](https://github.com/mcp-use/mcp-use)
├── resources/ # React widget components
│ ├── components/ # Reusable UI components
│ ├── schema-explorer/ # Schema explorer widget
│ ├── table-viewer/ # Table viewer widget
│ ├── supabase-status/ # Display Supabase status for a certain time window
│ └── query-results/ # Query results widget
└── package.json # Dependencies including [mcp-use](https://github.com/mcp-use/mcp-use)
许可证
麻省理工学院