SurrealDB MCP Server

SurrealDB MCP Server

site icon
2025.04.16 8
JavaScript数据库中间件AI数据库接口数据库开发效率
SurrealDB MCP Server 是一个实现了模型上下文协议(MCP)的服务,为AI助手提供了一个标准化的接口来与SurrealDB数据库进行交互。该服务使AI系统能够查询和操作配置好的SurrealDB实例中的数据。
View on GitHub

Overview

基本能力

产品定位

SurrealDB MCP Server 是一个中间件服务,旨在桥接AI助手与SurrealDB数据库之间的交互,提供标准化的数据操作接口。

核心功能

  • 提供对SurrealDB数据库的标准化访问接口
  • 支持多种数据操作:查询、创建、更新、删除、合并、插入等
  • 支持多种AI助手平台集成(如Cline、Claude、Copilot等)
  • 提供环境变量配置方式连接SurrealDB实例

适用场景

  • AI助手需要访问和操作数据库的场景
  • 需要将AI能力与数据库操作集成的应用
  • 开发AI驱动的数据库管理工具

工具列表

  • query: 执行原始SurrealQL查询
  • select: 从表中选择记录
  • create: 在表中创建新记录
  • update: 更新特定记录
  • delete: 按ID删除特定记录
  • merge: 将数据合并到特定记录(部分更新)
  • patch: 对特定记录应用JSON Patch操作
  • upsert: 如果记录不存在则创建,存在则更新
  • insert: 向表中插入多条记录
  • insertRelation: 在两个记录之间创建图关系(边)

常见问题解答

  • "Cannot find module"错误:检查全局安装和路径配置
  • 连接错误:验证SurrealDB是否运行,检查连接URL和凭据
  • Cline特定问题:使用全局安装方法并指定完整路径

使用教程

使用依赖

  • Node.js (>=18.0.0)
  • npm

安装教程

  1. 全局安装包:
npm install -g surrealdb-mcp-server
  1. 根据使用的AI助手平台配置相应的设置文件
  2. 设置环境变量:
  3. SURREALDB_URL
  4. SURREALDB_NS
  5. SURREALDB_DB
  6. SURREALDB_USER
  7. SURREALDB_PASS

调试方式

  1. 验证安装:
npm list -g surrealdb-mcp-server
  1. 检查SurrealDB连接:
surreal start --log debug
  1. 在AI助手中列出可用MCP服务器,确认"surrealdb"在列表中

许可证

该项目遵循 Other 开源许可条款,请参阅 Other 了解完整条款。