Singlestore MCP Server

用于与SingleStore管理API和服务交互的MCP服务器。

什么是MCP服务器？

特性

可用工具（16个）

---

工具详情

工具：create_job_from_notebook

创建计划任务以运行（已上传到共享空间的）笔记本。

---

工具：create_notebook_file

创建符合SingleStore格式的Jupyter笔记本文件并保存到临时位置。

此工具会根据Jupyter笔记本架构验证提供的内容，并在临时位置创建格式正确的.ipynb文件。内容会从简化格式转换为完整的Jupyter笔记本格式。

---

工具：create_starter_workspace

使用SingleStore SDK创建新的入门工作区。

此工具提供了基于现代SDK的入门工作区创建方法，与直接API调用相比，具有更高的可靠性和更好的错误处理能力。

---

工具：delete_job

通过ID删除计划任务。

---

工具：get_job

通过ID检索计划任务的详细信息。

---

工具：get_user_info

检索当前用户的所有信息。

返回：
    dict: 包含userID、email、firstName、lastName的用户信息。

性能提示：
进行多次API调用时缓存返回的信息。

工具：list_regions

列出用户可部署SingleStore工作区的所有可用部署区域。

返回的区域信息包括：
- regionID: 区域的唯一标识符
- provider: 云提供商（AWS、GCP或Azure）
- name: 人类可读的区域名称（例如：Europe West 2 (London)、US West 2 (Oregon)）

使用此工具可：
1. 基于以下因素选择最佳部署区域：
   - 与用户的地理 proximity
   - 合规要求
   - 成本考虑
   - 可用的云提供商
2. 规划多区域部署

工具：list_sharedtier_regions

列出可创建共享层工作区的所有区域。

此工具提供有关可创建入门工作区的可用区域信息，包括区域名称和云提供商。

工具：list_starter_workspaces

列出用户在SingleStore中可用的所有入门（虚拟）工作区。

返回每个入门工作区的详细信息：
- virtualWorkspaceID: 工作区的唯一标识符
- name: 工作区的显示名称
- endpoint: 连接端点URL
- databaseName: 主数据库名称
- mysqlDmlPort: MySQL协议连接端口
- webSocketPort: WebSocket连接端口
- state: 工作区的当前状态

使用此工具可：
1. 获取其他操作所需的入门工作区ID
2. 检查入门工作区的可用性和状态
3. 获取数据库访问的连接详细信息

工具：organization_info

检索当前用户在SingleStore中的组织信息。

返回的组织详情包括：
- orgID: 组织的唯一标识符
- name: 组织的显示名称

工具：resume_workspace

在SingleStore中恢复指定工作区组内的工作区。

---

工具：run_sql

使用此工具对SingleStore数据库执行单个SQL语句。

返回：
- 包含列名和类型化值的查询结果
- 行数和元数据
- 执行状态
- 工作区类型（"shared"表示入门工作区，"dedicated"表示常规工作区）
- 工作区名称

---

工具：terminate_starter_workspace

永久删除SingleStore中的入门工作区，包含安全确认。

⚠️ 警告：此操作无法撤销。所有工作区数据将被永久删除。
继续之前请确保备份重要数据。

安全特性：
- 需要明确的用户确认（如果支持启发式询问）
- 验证工作区是否存在
- 提供警告消息
- 包含错误处理

---

工具：upload_notebook_file

将本地路径的笔记本文件上传到SingleStore的共享或个人空间。

此工具在上传前验证笔记本架构。如果未提供upload_name或upload_location，将通过启发式询问提示用户。

---

工具：workspace_groups_info

列出用户在SingleStore中可访问的所有工作区组。

返回每个组的详细信息：
- workspaceGroupID: 组的唯一标识符
- name: 工作区组的显示名称
- region: 区域信息（名称、提供商）
- firewallRanges: 组的允许IP范围列表
- allowAllTraffic: 是否允许所有流量访问该组
- createdAt: 组创建的时间戳
- terminatedAt: 组终止的时间戳（如适用）


使用此工具可：
1. 获取其他操作所需的工作区组ID
2. 规划维护窗口

相关操作：
- 使用workspaces_info列出组内的工作区
- 使用execute_sql在组内的工作区上运行查询

工具：workspaces_info

列出SingleStore中指定工作区组内的所有工作区。

返回每个工作区的详细信息：
- createdAt: 工作区创建的时间戳
- deploymentType: 部署类型（例如：'PRODUCTION'）
- endpoint: 数据库访问的连接URL
- name: 工作区的显示名称
- size: 计算和存储配置
- state: 当前状态（例如：'ACTIVE'、'PAUSED'）
- terminatedAt: 终止时间戳（如适用）
- workspaceGroupID: 工作区组标识符
- workspaceID: 工作区的唯一标识符

---

使用此MCP服务器

json
{
  "mcpServers": {
    "singlestore": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "MCP_API_KEY",
        "mcp/singlestore"
      ],
      "env": {
        "MCP_API_KEY": "<MCP_API_KEY>"
      }
    }
  }
}

为什么使用Docker运行MCP服务器更安全？