Okctl MCP Server

🚀 OceanBase Kubernetes 控制工具 MCP 服務器項目

本項目是 OceanBase Kubernetes 控制工具（okctl）的 MCP 服務器實現。它藉助一組工具函數，實現對 OceanBase 集群、租戶和備份策略的管理。這些功能通過調用底層 okctl 命令行工具，並使用 MCP 協議將其暴露給客戶端來達成。

🚀 快速開始

本項目提供了一系列管理 OceanBase 相關資源的功能，下面將為你介紹如何配置開發環境並使用這些功能。

✨ 主要特性

本項目包含以下主要工具，為 OceanBase 的管理提供全面支持：

1. 集群管理（clusters.py）

提供創建、刪除、查看、縮放、更新和升級 OceanBase 集群的功能：

• list_all_clusters() - 列出所有 OceanBase 集群
• show_cluster() - 顯示指定集群的詳細信息
• create_cluster() - 創建新的 OceanBase 集群
• delete_cluster() - 刪除指定的 OceanBase 集群
• scale_cluster() - 縮放 OceanBase 集群
• update_cluster() - 更新 OceanBase 集群配置
• upgrade_cluster() - 升級 OceanBase 集群版本

2. 租戶管理（tenants.py）

提供創建、刪除、查看、縮放、更新和管理 OceanBase 租戶的功能：

• list_tenants() - 列出所有租戶
• create_tenant() - 創建新的租戶
• delete_tenant() - 刪除指定的租戶
• show_tenant() - 顯示租戶的詳細信息
• scale_tenant() - 縮放租戶資源
• update_tenant() - 更新租戶配置
• upgrade_tenant() - 升級租戶版本
• change_tenant_password() - 修改租戶密碼
• activate_tenant() - 激活備用租戶
• replay_tenant_log() - 重放租戶日誌
• switchover_tenant() - 切換主備租戶

3. 備份策略管理（backup_policy.py）

提供創建、刪除、查看、更新和管理 OceanBase 備份策略的功能：

• list_backup_policies() - 列出所有備份策略
• create_backup_policy() - 創建新的備份策略
• delete_backup_policy() - 刪除指定的備份策略
• show_backup_policy() - 顯示備份策略的詳細信息
• update_backup_policy() - 更新備份策略
• pause_backup_policy() - 暫停備份策略
• resume_backup_policy() - 恢復備份策略

4. 組件管理（components.py）

提供安裝、更新和管理 OceanBase 組件的功能：

• list_components() - 列出所有已安裝的組件
• install_component() - 安裝新的組件
• update_component() - 更新組件

📦 安裝指南

先決條件

• 已安裝 Python 3.10 或更高版本
• uv 包管理器已安裝（uv 官方文檔）
• OceanBase Kubernetes 控制工具 (okctl) 已安裝並配置完成
• Kubernetes 環境已配置，具有對 OceanBase 集群的訪問權限

配置 MCP 服務器

{
  "mcpServers": {
    "okctl-mcp-server-py": {
      "command": "uv",
      "args": ["--directory", "/path/to/okctl-mcp-server-py", "run", "main.py"]
    }
  }
}

📚 詳細文檔

重要說明

⚠️ 重要提示

• 服務器需要在具有 Kubernetes 集群訪問權限的環境中運行。
• 所有功能均通過調用底層 okctl 命令行工具實現，因此請確保 okctl 已正確安裝和配置。
• 大多數功能提供了一個默認值為“default”的命名空間參數，可以根據需要指定。
• 某些操作（如刪除集群、刪除租戶）可能是不可逆的，請謹慎執行。

💡 使用建議

建議在執行重要操作前進行備份。

貢獻

歡迎提交問題和拉取請求以改進該項目。

📄 許可證

該項目根據 MIT License 許可。