SingleStore MCP 服务器

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

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

快速入门

通过 Smithery 安装

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

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

克隆存储库

要克隆存储库并在本地设置服务器：

git clone https://github.com/singlestore-labs/mcp-server-singlestore.git
cd mcp-server-singlestore
# 安装依赖
pip install -e .

通过 pip 安装

或者，您可以使用 pip 安装该软件包：

pip install singlestore-mcp-server

使用命令 singlestore-mcp-client 运行带有 mcp 客户端或 mcp 检查器的服务器。

本地安装配置

在本地使用 Claude Desktop 或其他 MCP 客户端运行 MCP 服务器时，您需要将服务器配置添加到 Claude Desktop 设置。 以下是一个您可以添加到 Claude Desktop 配置的示例：

{
  "mcpServers": {
    "singlestore-mcp-server": {
      "command": "/path/to/singlestore-mcp-server",
      "env": {
        "SINGLESTORE_DB_USERNAME": "your-database-username",
        "SINGLESTORE_DB_PASSWORD": "your-database-password",
        "SINGLESTORE_API_KEY": "your-api-key"
      }
    }
  }
}

请确保：

1. 更新 command 路径以匹配 singlestore-mcp-server 在您的系统上的安装位置
2. 在 env 部分中设置您的 SingleStore 数据库凭据
3. 更改配置后重新启动 Claude Desktop

组件

工具

服务器实现了以下工具：

• workspace_groups_info: 检索有关用户可访问的工作区组的详细信息
  • 无需参数
  • 返回工作区组的详细信息
• workspaces_info: 检索有关特定工作区组中工作区的详细信息
  • 参数：workspaceGroupID (字符串)
  • 返回工作区的详细信息
• organization_info: 检索有关用户当前组织的详细信息
  • 无需参数
  • 返回组织的详细信息
• list_of_regions: 检索支持用户工作区的所有区域的列表
  • 无需参数
  • 返回区域列表
• execute_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 中所有可用的 Notebook 示例
  • 无需参数
  • 返回可用 Notebook 示例的详细信息
• create_notebook: 在用户的个人空间中创建一个新的 Notebook
  • 参数：notebook_name、content（可选）
  • 返回已创建的 Notebook 的详细信息
• list_personal_files: 列出用户个人空间中的所有文件
  • 无需参数
  • 返回用户个人空间中所有文件的详细信息
• create_scheduled_job: 创建一个新的计划作业来运行 Notebook
  • 参数：
    • name: 作业名称
    • notebook_path: 要执行的 Notebook 的路径
    • schedule_mode: Once 或 Recurring
    • execution_interval_minutes: 执行之间的分钟数（可选）
    • start_at: 作业开始时间（可选）
    • description: 作业描述（可选）
    • create_snapshot: 是否创建 Notebook 快照（可选）
    • runtime_name: 运行时环境的名称
    • parameters: 作业参数（可选）
    • target_config: 作业的目标配置（可选）
  • 返回已创建的作业的详细信息
• get_job_details: 获取有关特定作业的详细信息
  • 参数：job_id
  • 返回有关指定作业的详细信息
• list_job_executions: 列出特定作业的执行历史记录
  • 参数：job_id、start（可选）、end（可选）
  • 返回指定作业的执行历史记录

配置

服务器需要以下环境变量：

# SingleStore 的管理 API 密钥（必需）
SINGLESTORE_API_KEY=your_api_key_here

# 数据库凭据（可选 - 可以作为输入参数提供）
SINGLESTORE_DB_USERNAME=your_db_username_here
SINGLESTORE_DB_PASSWORD=your_db_password_here