SingleStore MCP Server

SingleStore MCP Server

site icon
2025.03.12 3
JavaScript数据库管理SQL查询数据库可视化数据库
SingleStore MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器,专门用于与 SingleStore 数据库进行交互。它提供了一系列工具,用于查询表、描述数据库模式以及生成实体关系图(ER 图)。该服务器支持两种协议:标准的 MCP 协议和使用 Server-Sent Events (SSE) 的 HTTP 协议,适用于不同的客户端集成需求。
View on GitHub

Overview

基本能力

产品定位

SingleStore MCP Server 是一个数据库交互工具,专门设计用于与 SingleStore 数据库进行高效、安全的交互。它通过提供一系列数据库操作工具,简化了数据库管理和查询过程。

核心功能

  • 数据库表管理:列出所有表、获取表详细信息
  • SQL 查询执行:支持自定义 SQL 查询和只读查询
  • 数据库模式可视化:生成 Mermaid ER 图
  • 表创建:支持创建新表并指定列和约束
  • 数据生成:生成并插入合成数据到现有表
  • SQL 优化:分析 SQL 查询并提供优化建议
  • SSL 支持:自动获取 SingleStore CA 包
  • 错误处理:完善的错误处理和 TypeScript 类型安全

适用场景

  • 数据库管理和维护
  • 数据库模式设计和可视化
  • SQL 查询优化
  • 数据库应用开发
  • 数据分析和报告生成

工具列表

  1. list_tables:列出数据库中的所有表
  2. query_table:执行自定义 SQL 查询
  3. describe_table:获取表的详细信息(包括模式和示例数据)
  4. generate_er_diagram:生成数据库模式的 Mermaid ER 图
  5. run_read_query:执行只读(SELECT)查询
  6. create_table:创建新表
  7. generate_synthetic_data:生成并插入合成数据
  8. optimize_sql:分析 SQL 查询并提供优化建议

常见问题解答

  1. 连接问题:检查凭据和主机信息,验证 SSL 配置,确保数据库可从网络访问
  2. 构建问题:清除 node_modules 并重新安装依赖项,验证 TypeScript 配置
  3. MCP 集成问题:验证服务器路径是否正确,检查环境变量是否设置正确,重启客户端应用

使用教程

使用依赖

  • Node.js 16 或更高版本
  • npm 或 yarn
  • 访问 SingleStore 数据库
  • SingleStore CA 包(自动从门户获取)

安装教程

通过 Smithery 安装

npx -y @smithery/cli install @madhukarkumar/singlestore-mcp-server --client claude

手动安装

  1. 克隆仓库:
git clone <repository-url>
cd mcp-server-singlestore
  1. 安装依赖:
npm install
  1. 构建服务器:
npm run build

环境变量设置

必需环境变量

SINGLESTORE_HOST=your-host.singlestore.com
SINGLESTORE_PORT=3306
SINGLESTORE_USER=your-username
SINGLESTORE_PASSWORD=your-password
SINGLESTORE_DATABASE=your-database

可选环境变量(SSE 支持)

SSE_ENABLED=true
SSE_PORT=3333

调试方式

  1. 仅使用 MCP 协议运行服务器:
node build/index.js
  1. 同时使用 MCP 和 SSE 协议运行服务器:
SSE_ENABLED=true SSE_PORT=3333 node build/index.js
  1. 使用 MCP Inspector 进行调试:
npm run inspector
  1. 测试 SSE 连接:
npm run test:sse

curl -N http://localhost:8081/sse

许可证

该项目遵循 MIT 开源许可条款。