SurrealDB MCP Server

SurrealDB MCP Server

site icon
2025.04.13 0
JavaScript数据库中间件AI 工具集成数据库开发效率
SurrealDB MCP Server 是一个基于 Model Context Protocol (MCP) 的服务,为 AI 助手提供了一个标准化的接口来与 SurrealDB 数据库进行交互。该服务允许 AI 系统查询和操作配置好的 SurrealDB 实例中的数据。
View on GitHub

Overview

基本能力

产品定位

SurrealDB MCP Server 是一个连接 AI 助手与 SurrealDB 数据库的中间件,旨在简化 AI 系统对数据库的操作。

核心功能

  • 提供多种数据库操作工具,包括查询、选择、创建、更新、删除、合并、补丁、插入等
  • 支持多种 AI 助手平台集成(如 Cline、Claude、Copilot 等)
  • 提供标准化的 MCP 接口

适用场景

  • AI 助手需要访问和操作 SurrealDB 数据库的场景
  • 开发者在多种开发环境中集成 SurrealDB 功能
  • 自动化工作流中需要数据库操作的场景

工具列表

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

常见问题解答

  1. "Cannot find module" 错误
  2. 验证全局安装:npm list -g surrealdb-mcp-server
  3. 检查配置路径是否正确
  4. 尝试重新安装

  5. 连接错误

  6. 验证 SurrealDB 是否运行
  7. 检查连接 URL、命名空间、数据库和凭据
  8. 确保 SurrealDB 实例可访问

  9. Cline 特定问题

  10. 对 Cline 使用全局安装方法
  11. 指定 node.exe 和安装包的完整路径
  12. 确保替换正确的 Windows 用户名

使用教程

使用依赖

  • Node.js ≥18.0.0
  • MCP SDK ^1.6.1

安装教程

  1. 全局安装包:
npm install -g surrealdb-mcp-server
  1. 根据使用的 AI 助手平台配置相应的设置文件

调试方式

  1. 验证安装:
  2. 在 AI 助手中请求"列出可用的 MCP 服务器"
  3. 应该能看到"surrealdb"在列表中

  4. 运行本地开发版本:

npm run dev
# 或运行构建版本
npm start

许可证

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