SingleStore MCP Server

单店 MCP 服务器

模型上下文协议(MCP) 是一种标准化协议，旨在管理大型语言模型 (LLM) 与外部系统之间的上下文。此存储库为 Singlestore 提供了安装程序和 MCP 服务器，可实现无缝集成。

通过 MCP，您可以使用 Claude Desktop、Cursor 或任何兼容的 MCP 客户端通过自然语言与 SingleStore 进行交互，从而更轻松地执行复杂的操作。

要求

• Python >= v3.11.0
• uvx安装在你的 Python 环境中
• Claude Desktop、Cursor 或其他受支持的 LLM 客户端

客户端设置

1. Init 命令

设置 MCP 服务器最简单的方法是使用初始化命令：

此命令将：

1. 验证用户身份
2. 自动定位适合您平台的配置文件
3. 创建或更新配置以包含 SingleStore MCP 服务器
4. 提供启动服务器的说明

您还可以明确传递<SINGLESTORE_API_KEY> ：

要指定客户端（例如， claude或cursor ），请使用--client标志：

2.通过 Smithery 安装

要通过Smithery自动安装mcp-server-singlestore ：

根据需要将<client>替换为claude或cursor 。

3.手动配置

Claude 桌面和光标

1. 将以下配置添加到您的客户端配置文件中：

• 克劳德桌面：
• 光标
  { "mcpServers": { "singlestore-mcp-server": { "command": "uvx", "args": [ "singlestore-mcp-server", "start", "<SINGLESTORE_API_KEY>" ] } } }

2. 更改配置后重新启动客户端。

成分

工具

该服务器实现了以下工具：

• workspace_groups_info ：检索有关用户可访问的工作区组的详细信息
  • 无需任何参数
  • 返回工作区组的详细信息
• jobs_info ：检索有关特定工作区组中的工作区的详细信息
  • 参数： workspaceGroupID （字符串）
  • 返回工作区的详细信息
• organization_info ：检索有关用户当前组织的详细信息
  • 无需任何参数
  • 返回组织的详细信息
• list_of_regions ：检索支持用户工作区的所有区域的列表
  • 无需任何参数
  • 返回区域列表
• 执行SQL 操作：在连接的工作区上执行 SQL 操作
  • 参数： workspace_group_identifier 、 workspace_identifier 、 username 、 password 、 database 、 sql_query
  • 以结构化格式返回 SQL 查询的结果
• list_virtual_workspaces ：列出用户可访问的所有启动工作区
  • 无需任何参数
  • 返回可用启动工作区的详细信息
• create_virtual_workspace ：为用户创建一个新的启动工作区
  • 参数：
    • name ：启动工作区的名称
    • database_name ：要创建的数据库的名称
    • username ：访问工作区的用户名
    • password ：用户密码
    • workspace_group ：包含name （可选）和cellID （强制）的对象
  • 返回已创建的工作区和用户的详细信息
• execute_sql_on_virtual_workspace ：在虚拟工作区上执行 SQL 操作
  • 参数： virtual_workspace_id 、 username 、 password 、 sql_query
  • 以结构化格式返回 SQL 查询的结果，包括数据、行数、列和状态
• list_notebook_samples ：列出 SingleStore Spaces 中可用的所有笔记本示例
  • 无需任何参数
  • 返回可用笔记本样本的详细信息
• create_notebook ：在用户个人空间创建一个新的笔记本
  • 参数： notebook_name 、 content （可选）
  • 返回已创建笔记本的详细信息
• list_personal_files ：列出用户个人空间中的所有文件
  • 无需任何参数
  • 返回用户个人空间中所有文件的详细信息
• create_scheduled_job ：创建一个新的计划作业来运行笔记本
  • 参数：
    • name ：工作名称
    • notebook_path ：要执行的笔记本的路径
    • schedule_mode ：一次或重复
    • execution_interval_minutes ：执行间隔分钟数（可选）
    • start_at ：何时开始工作（可选）
    • description ：工作描述（可选）
    • create_snapshot ：是否创建笔记本快照（可选）
    • runtime_name ：运行时环境的名称
    • parameters ：作业的参数（可选）
    • target_config ：作业的目标配置（可选）
  • 返回已创建作业的详细信息
• get_job_details ：获取特定工作的详细信息
  • 参数： job_id
  • 返回指定作业的详细信息
• list_job_executions ：列出特定作业的执行历史记录
  • 参数： job_id 、 start （可选）、 end （可选）
  • 返回指定作业的执行历史记录

Docker化

构建 Docker 镜像

要为 MCP 服务器构建 Docker 镜像，请在项目根目录中运行以下命令：

运行 Docker 容器

要运行 Docker 容器，请使用以下命令：

使用 Docker Secrets

为了安全地将机密传递给容器，请创建 Docker 机密并挂载它：

然后，使用秘密运行容器：