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 文件瞭解詳細信息。我們歡迎您提出的改進和修復！