Gel Database MCP Server

Gel Database MCP Server

site icon
2025.03.03 9
TypeScript数据库操作自然语言查询LLM 代理集成数据库开发效率
Gel Database MCP Server 是一个基于 TypeScript 的 Model Context Protocol (MCP) 服务器,旨在通过 EdgeQL 查询简化 Gel 数据库操作。该项目为 LLM 代理(如 Cursor Agent、Claude Code 等)提供工具,用于自动化学习数据库模式、编写、验证和执行数据库查询。用户可以通过自然语言轻松与 Gel 数据库交互。
View on GitHub

Overview

基本能力

产品定位

Gel Database MCP Server 是一个数据库操作工具,专注于通过自然语言和 LLM 代理简化 Gel 数据库的查询和管理。

核心功能

  1. describe-schema: 帮助 LLM 代理学习和理解数据库结构,包括实体类型、属性、关系和约束。
  2. validate-query: 验证 EdgeQL 查询语法,避免执行错误查询。
  3. execute-edgeql: 直接执行 EdgeQL 查询,与数据库交互。
  4. search-gel-docs: 搜索 Gel 文档,获取 EdgeQL 语法和特性的相关信息。
  5. execute-typescript: 执行使用查询构建器语法编写的 TypeScript Gel 查询。

适用场景

  1. 数据库开发: 通过自然语言快速生成和验证数据库查询。
  2. LLM 代理集成: 为 LLM 代理提供数据库操作能力,如查询生成和执行。
  3. 文档搜索: 快速查找 Gel 数据库的相关文档和示例。
  4. 复杂查询开发: 使用 TypeScript 编写和执行复杂的数据库查询。

工具列表

  1. describe-schema: 用于理解数据库结构。
  2. validate-query: 用于验证查询语法。
  3. execute-edgeql: 用于执行 EdgeQL 查询。
  4. search-gel-docs: 用于搜索 Gel 文档。
  5. execute-typescript: 用于执行 TypeScript 查询。

常见问题解答

  1. 查询生成: 不包括查询生成功能,因为 LLM 可以编写更灵活的查询。
  2. 测试环境: 主要在 Cursor 代理中使用 Claude-3.7-sonnet-thinking 进行测试。
  3. 文档访问: 推荐同时使用 gel_llm.txt 文件和 search-gel-docs 工具。

使用教程

使用依赖

yarn install

安装教程

  1. 复制 dbschema 文件夹到项目目录(如果已有)。
  2. 初始化 Gel 项目:
npx gel project init
  1. 生成 EdgeQL JavaScript 查询构建器文件:
npx @gel/generate edgeql-js
  1. 更新连接设置(编辑 src/index_gel.ts)。
  2. 构建项目:
yarn build
  1. 测试服务器:
node build/index.js
  1. 使用 UI 测试服务器(可选):
npx @modelcontextprotocol/inspector node build/index.js
  1. 包含 gel_llm.txt 文档文件(可选):
curl -o gel_llm.txt https://raw.githubusercontent.com/yourorg/gel-docs/main/gel_llm.txt

调试方式

  1. 在 Cursor 中连接 MCP 服务器:
  2. 点击右上角的齿轮图标 > MCP > +Add a new server。
  3. 选择类型为 Command,输入:node your/full/path/to/build/index.js
  4. 测试服务器是否正常运行。
  5. 检查错误日志(如有)。

许可证

None