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 许可。