Oceanbase MCP Server

🚀 OceanBase MCP 服務器

OceanBase MCP 服務器是一個用於管理 OceanBase 數據庫的工具，它可以列出可用的 OceanBase 表、讀取表內容、執行 SQL 查詢等，同時通過環境變量實現數據庫的安全訪問，並提供全面的日誌記錄功能。

🚀 快速開始

OceanBase MCP 服務器提供了便捷的方式來管理 OceanBase 數據庫。你可以通過安裝和配置該服務器，輕鬆實現對數據庫的各種操作。

✨ 主要特性

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

📦 安裝指南

使用以下命令安裝 OceanBase MCP 服務器：

pip install oceanbase-mcp-server

📚 詳細文檔

配置環境變量

設置以下環境變量以連接到 OceanBase 數據庫：

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 用戶
• 設置適當的權限
• 監控數據庫訪問
• 獲取安全最佳實踐

⚠️ 重要提示

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

貢獻流程

1. 復刻倉庫
2. 創建功能分支 (git checkout -b feature/amazing-feature)
3. 提交更改 (git commit -m 'Add some amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 打開 Pull Request

📄 許可證

本項目採用 Apache 許可證 - 請參閱 LICENSE 文件以獲取詳細信息。