Oceanbase

🚀 OceanBase MCP 服務器

OceanBase MCP 服務器能夠列出 OceanBase 表資源、讀取表內容、執行 SQL 查詢，還支持通過環境變量安全訪問數據庫，同時具備全面的日誌記錄功能，為數據庫操作提供便利與安全保障。

✨ 主要特性

• 列出可用的 OceanBase 表作為資源
• 讀取表內容
• 執行 SQL 查詢並進行適當的錯誤處理
• 通過環境變量實現數據庫的安全訪問
• 全面的日誌記錄

📦 安裝指南

pip install oceanbase-mcp-server

🛠️ 配置說明

設置以下環境變量：

OB_HOST=localhost     # 數據庫主機
OB_PORT=2881         # 可選：數據庫端口（如果沒有指定，默認為 2881）
OB_USER=your_username
OB_PASSWORD=your_password
OB_DATABASE=your_database

💻 使用示例

基礎用法

在 Claude Desktop 中使用

將以下內容添加到你的 claude_desktop_config.json 文件中：

{
  "mcpServers": {
    "oceanbase": {
      "command": "uv",
      "args": [
        "--directory", 
        "path/to/oceanbase_mcp_server",
        "run",
        "oceanbase_mcp_server"
      ],
      "env": {
        "OB_HOST": "localhost",
        "OB_PORT": "2881",
        "OB_USER": "your_username",
        "OB_PASSWORD": "your_password",
        "OB_DATABASE": "your_database"
      }
    }
  }
}

作為獨立服務器運行

# 安裝依賴項
pip install -r requirements.txt

# 啟動服務器
python -m oceanbase_mcp_server

👨‍💻 開發指引

# 克隆倉庫
git clone https://github.com/yourusername/oceanbase_mcp_server.git
cd oceanbase_mcp_server

# 創建虛擬環境
python -m venv venv
source venv/bin/activate  # 或 `venv\Scripts\activate` 在 Windows 上

# 安裝開發依賴項
pip install -r requirements-dev.txt

# 運行測試
pytest

⚠️ 安全注意事項

• 永遠不要提交環境變量或憑據
• 使用權限最小的數據庫用戶
• 考慮在生產環境中實施查詢白名單
• 監控和記錄所有數據庫操作

🌟 安全最佳實踐

此 MCP 服務器需要數據庫訪問權限才能運行。出於安全考慮：

1. 創建一個專用的 OceanBase 用戶，並賦予最小的權限
2. 不要使用 root 憑據 或管理賬戶
3. 限制數據庫訪問，使其僅限於必要的操作
4. 啟用日誌記錄 以進行審核
5. 定期進行安全審查 以檢查數據庫訪問情況

請參閱 OceanBase 安全配置指南 以瞭解詳細說明：

• 創建受限的 OceanBase 用戶
• 設置適當的權限
• 監控數據庫訪問
• 安全最佳實踐

⚠️ 重要提示

在配置數據庫訪問時，始終遵循最小特權原則。

📄 許可證

Apache License - 有關詳細信息，請參閱 LICENSE 文件。

🤝 貢獻指南

1. 分叉倉庫
2. 創建你的功能分支（git checkout -b feature/amazing-feature）
3. 提交你的更改（git commit -m 'Add some amazing feature'）
4. 推送到分支（git push origin feature/amazing-feature）
5. 打開一個拉取請求