使用说明
项目简介
SingleStore MCP Server 是一个允许 AI 助手安全访问 SingleStore 数据库的后端服务。它通过标准化的 MCP 协议,使 AI 助手能够浏览数据库中的表,读取数据内容,并执行 SQL 查询,从而实现结构化和安全的数据库交互。
主要功能点
- 将 SingleStore 数据库表作为资源列出。
- 读取表数据,支持多种数据格式。
- 执行 SQL 查询,并进行错误处理。
- 支持 SingleStore 特定的数据类型和功能。
- 通过环境变量安全地配置数据库连接。
安装步骤
pip install singlestore-mcp-server
服务器配置
对于 MCP 客户端 (如 Claude Desktop),需要在客户端的配置文件中添加以下服务器配置信息。以下是 'claude_desktop_config.json' 的配置示例:
{ "mcpServers": { "singlestore": { "command": "uv", "args": [ "--directory", "path/to/singlestore_mcp_server", "run", "singlestore_mcp_server" ], "env": { "SINGLESTORE_HOST": "your_workspace_host", // 您的 SingleStore 工作区主机地址 "SINGLESTORE_PORT": "3306", // SingleStore 端口,默认为 3306 "SINGLESTORE_USER": "your_username", // 数据库用户名 "SINGLESTORE_PASSWORD": "your_password", // 数据库密码 "SINGLESTORE_DATABASE": "your_database" // 要连接的数据库名称 } } } }
配置参数说明:
- 'server name': 服务器名称,例如 "singlestore",客户端用此名称引用该服务器。
- 'command': 启动服务器的命令,这里使用 'uv' 运行 Python 模块。
- 'args': 传递给 'command' 的参数列表:
- '--directory': 指向 'singlestore_mcp_server' 项目的路径。需要替换为实际路径。
- 'run': 'uv' 的子命令,用于运行模块。
- 'singlestore_mcp_server': 要运行的 Python 模块名。
- 'env': 环境变量配置,用于数据库连接:
- 'SINGLESTORE_HOST', 'SINGLESTORE_PORT', 'SINGLESTORE_USER', 'SINGLESTORE_PASSWORD', 'SINGLESTORE_DATABASE': SingleStore 数据库连接所需的凭据和信息。需要替换为您的实际数据库配置。
基本使用方法
- 确保已安装 Python 和 pip。
- 安装 'singlestore-mcp-server': 'pip install singlestore-mcp-server'
- 配置 SingleStore 数据库连接环境变量 (SINGLESTORE_HOST, SINGLESTORE_PORT, SINGLESTORE_USER, SINGLESTORE_PASSWORD, SINGLESTORE_DATABASE)。
- 对于 MCP 客户端,配置 'claude_desktop_config.json' 文件,指定服务器启动命令和连接参数。
- 启动 MCP 客户端,客户端将通过 MCP 协议与此服务器通信,从而访问 SingleStore 数据库。
信息
分类
数据库与文件