Okctl MCP Server

🚀 OceanBase Kubernetes MCP Server

This project is an MCP server implementation for the OceanBase Kubernetes control tool (okctl). It offers a set of utility functions to manage OceanBase clusters, tenants, and backup policies. These functions are implemented by invoking the underlying okctl command-line tool and exposing them to clients using the MCP protocol.

🚀 Quick Start

This project provides a comprehensive set of tools for managing OceanBase clusters, tenants, backup policies, and components. Below is a brief overview of its main functionalities:

✨ Features

Cluster Management (clusters.py)

This module provides functions for creating, deleting, viewing, scaling, updating, and upgrading OceanBase clusters.

• list_all_clusters() - List all OceanBase clusters.
• show_cluster() - Display detailed information about a specified cluster.
• create_cluster() - Create a new OceanBase cluster.
• delete_cluster() - Delete a specified OceanBase cluster.
• scale_cluster() - Scale an OceanBase cluster.
• update_cluster() - Update the configuration of an OceanBase cluster.
• upgrade_cluster() - Upgrade the version of an OceanBase cluster.

Tenant Management (tenants.py)

This module provides functions for creating, deleting, viewing, scaling, updating, and managing OceanBase tenants.

• list_tenants() - List all tenants.
• create_tenant() - Create a new tenant.
• delete_tenant() - Delete a specified tenant.
• show_tenant() - Display detailed information about a tenant.
• scale_tenant() - Scale tenant resources.
• update_tenant() - Update tenant configuration.
• upgrade_tenant() - Upgrade the tenant version.
• change_tenant_password() - Change the tenant password.
• activate_tenant() - Activate a standby tenant.
• replay_tenant_log() - Replay tenant logs.
• switchover_tenant() - Switch between primary and standby tenants.

Backup Policy Management (backup_policy.py)

This module provides functions for creating, deleting, viewing, updating, and managing OceanBase backup policies.

• list_backup_policies() - List all backup policies.
• create_backup_policy() - Create a new backup policy.
• delete_backup_policy() - Delete a specified backup policy.
• show_backup_policy() - Display detailed information about a backup policy.
• update_backup_policy() - Update a backup policy.
• pause_backup_policy() - Pause a backup policy.
• resume_backup_policy() - Resume a backup policy.

Component Management (components.py)

This module provides functions for installing, updating, and managing OceanBase components.

• list_components() - List all installed components.
• install_component() - Install a new component.
• update_component() - Update a component.

📦 Installation

Prerequisites

• Python 3.10 or higher is installed.
• The uv package manager is installed (uv official documentation).
• The OceanBase Kubernetes control tool (okctl) is installed and configured.
• The Kubernetes environment is configured with access to the OceanBase cluster.

Configure the MCP Server

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

📚 Documentation

Important Notes

• The server needs to run in an environment with access to the Kubernetes cluster.
• All functions are implemented by invoking the underlying okctl command-line tool. Ensure that okctl is correctly installed and configured.
• Most functions provide a namespace parameter with a default value of "default", which can be specified as needed.
• Some operations (e.g., deleting a cluster or tenant) may be irreversible. Exercise caution when performing them.
• It is recommended to perform backups before executing important operations.

🔗 Contribution

We welcome issues and pull requests to improve this project.

📄 License

This project is licensed under the MIT License.