Madhukarkumar Singlestore MCP Server

🚀 SingleStore MCP 服务器

SingleStore MCP 服务器是一个支持安全交互的数据库模型上下文协议（MCP）服务器。它允许 AI 助手列出表格、读取数据以及通过受控接口执行 SQL 查询，为数据库探索和分析提供了安全且结构化的解决方案。

🚀 快速开始

SingleStore MCP 服务器可助力 AI 助手安全地与数据库交互。你可按如下步骤开始使用：

1. 完成服务器的安装。
2. 进行相应的配置。
3. 按照不同场景的使用方法进行操作。

✨ 主要特性

• 可将可用的 SingleStore 表格作为资源列出。
• 支持以多种格式（包括 BSON 和 JSON）读取消息内容。
• 执行 SQL 查询时具备错误处理功能。
• 支持 SingleStore 特定的数据类型和函数。
• 通过环境变量保障数据库访问的安全性。
• 具备全面的日志记录功能。

📦 安装指南

使用以下命令安装 singlestore-mcp-server：

pip install singlestore-mcp-server

📦 配置说明

设置以下环境变量：

SINGLESTORE_HOST=your_workspace_host
SINGLESTORE_PORT=3306  # SingleStore 的默认端口
SINGLESTORE_USER=your_username
SINGLESTORE_PASSWORD=your_password
SINGLESTORE_DATABASE=your_database

💻 使用示例

在 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_PORT": "3306",
        "SINGLESTORE_USER": "your_username",
        "SINGLESTORE_PASSWORD": "your_password",
        "SINGLESTORE_DATABASE": "your_database"
      }
    }
  }
}

作为独立服务器运行

# 安装依赖项
pip install -r requirements.txt

# 运行服务器
python -m singlestore_mcp_server

📚 详细文档

开发步骤

# 克隆仓库
git clone https://github.com/yourusername/singlestore_mcp_server.git
cd singlestore_mcp_server

# 创建虚拟环境
python -m venv venv
source venv/bin/activate  # 或 `venv\Scripts\activate` 在 Windows 上

# 安装开发依赖项
pip install -r requirements-dev.txt

# 运行测试
pytest

SingleStore 特定功能

• 支持 BSON 数据类型和操作。
• 具备原生 JSON 处理能力，支持 SingleStore 的 JSON 函数。
• 支持 SingleStore Kai（MongoDB API 兼容性）。
• 能够正确处理 SingleStore 特定的数据类型。

安全注意事项

• 永远不要提交环境变量或凭证。
• 使用权限最小的数据库用户。
• 考虑在生产环境中实施查询白名单。
• 监控和记录所有数据库操作。

安全最佳实践

此 MCP 服务器需要数据库访问权限才能运行。为了安全起见：

1. 创建一个专用的 SingleStore 用户，赋予最小权限。
2. 避免将敏感凭证硬编码到配置文件或代码中。
3. 定期审查和更新访问策略以确保安全性。
4. 启用审计日志以监控数据库活动。

如需详细了解安全建议，请参考 SingleStore 安全指南。

📄 许可证

项目遵循 LICENSE 协议，具体内容请参阅相关文件。

🤝 贡献指南

如果希望为该项目做出贡献，请参考 CONTRIBUTING.md 文件了解详细信息。我们欢迎您提出的改进和修复！