使用说明

项目简介

SingleStore MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，它充当 LLM 应用和 SingleStore 数据库之间的桥梁。该服务器允许 LLM 安全地探索数据库结构、读取数据以及执行 SQL 查询，从而扩展 LLM 在数据分析和应用构建方面的能力。

主要功能点

资源浏览: 允许 LLM 列出 SingleStore 数据库中可用的表，方便用户了解数据结构。
数据读取: 支持 LLM 读取表中的数据内容，并以 JSON 格式返回，方便 LLM 理解和处理。
SQL 查询执行: 提供工具让 LLM 执行自定义 SQL 查询，实现更复杂的数据分析和操作。
安全访问控制: 通过环境变量配置数据库连接信息，保障数据库访问安全。
详细日志: 记录所有数据库操作，方便审计和问题排查。

安装步骤

安装 Python 包: 使用 pip 命令安装 'singlestore-mcp-server' 包。

pip install singlestore-mcp-server

服务器配置

MCP 客户端 (例如 Claude Desktop) 需要配置 MCP 服务器的启动信息才能连接。以下是针对 'singlestore-mcp-server' 的配置示例，请根据你的实际情况进行调整。

{
  "mcpServers": {
    "singlestore": {  //  服务器名称，客户端用以识别和调用
      "command": "uv",  //  启动服务器的命令，这里使用 uv (或 python -m) 运行
      "args": [  //  命令参数
        "--directory",  //  指定工作目录
        "path/to/singlestore_mcp_server", //  替换为 singlestore_mcp_server 包的安装路径，通常在 Python 环境的 site-packages 目录下
        "run",  //  uv run 命令，表示运行 Python 模块
        "singlestore_mcp_server"  //  要运行的 Python 模块名，即 singlestore_mcp_server
      ],
      "env": {  //  环境变量配置，用于数据库连接
        "SINGLESTORE_HOST": "your_workspace_host",  //  替换为你的 SingleStore 工作区主机地址
        "SINGLESTORE_PORT": "3306",  //  SingleStore 默认端口，通常无需修改
        "SINGLESTORE_USER": "your_username",  //  替换为你的 SingleStore 用户名
        "SINGLESTORE_PASSWORD": "your_password",  //  替换为你的 SingleStore 密码
        "SINGLESTORE_DATABASE": "your_database"  //  替换为你要连接的 SingleStore 数据库名
      }
    }
  }
}

注意:

'path/to/singlestore_mcp_server' 需要替换为 'singlestore-mcp-server' 包实际的安装路径。你可以通过 'pip show singlestore-mcp-server' 命令查看 Location 信息来找到安装路径。通常情况下，如果使用虚拟环境安装，路径会在虚拟环境的 'lib/pythonX.X/site-packages' 目录下。
请务必将 'your_workspace_host', 'your_username', 'your_password', 'your_database' 替换为你的 SingleStore 数据库的真实连接信息。
生产环境中，建议使用更安全的密钥管理方式，例如从Secret Manager 或 Vault 中加载数据库凭据，而不是直接硬编码在配置文件或环境变量中。

基本使用方法

启动 MCP 服务器: 配置好 MCP 客户端后，客户端会自动启动 'singlestore-mcp-server' 并与之建立连接。
在 LLM 中使用: 在支持 MCP 协议的 LLM 应用中 (例如 Claude Desktop)，你可以通过配置的服务器名称 ("singlestore" 在示例中) 来访问 SingleStore 数据库的功能。例如，你可以指示 LLM 列出数据库表，读取特定表的数据，或者执行 SQL 查询来分析数据。具体的指令和操作方式取决于 LLM 应用的功能和界面。

Standalone 运行服务器 (可选)

除了通过 MCP 客户端启动外，你也可以选择 Standalone 方式运行服务器进行测试或调试:

克隆仓库 (如果需要): 如果你想修改代码或从源码运行，可以克隆 GitHub 仓库到本地。

git clone https://github.com/MCP-Mirror/madhukarkumar_singlestore-mcp-server.git
cd madhukarkumar_singlestore-mcp-server

安装依赖: 如果从源码运行，需要安装 'requirements.txt' 中的依赖。

pip install -r requirements.txt

配置环境变量: 设置数据库连接相关的环境变量 ( 'SINGLESTORE_HOST', 'SINGLESTORE_PORT', 'SINGLESTORE_USER', 'SINGLESTORE_PASSWORD', 'SINGLESTORE_DATABASE' )。
运行服务器: 使用 Python 命令直接运行 'singlestore_mcp_server' 模块。

python -m singlestore_mcp_server

Standalone 运行模式主要用于开发测试，集成到 MCP 客户端时通常不需要手动 Standalone 运行。

关键词