OceanBase Kubernetes Control Tool (okctl) MCP Server

Name: OceanBase Kubernetes Control Tool (okctl) MCP Server
Author: lizzy-0323

@lizzy-0323

Repository

About OceanBase Kubernetes Control Tool (okctl) MCP Server

okctl's mcp server

Basic information

Config

Add this server to your MCP-compatible client using the configuration below.

{
  "mcpServers": {
    "okctl-mcp-server-py": {
      "command": "uv",
      "args": [
        "--directory",
        "/path/to/okctl-mcp-server",
        "run",
        "src/okctl/server.py"
      ],
      "env": {
        "OB_CLUSTER_PASSWORD": "<password of cluster>"
      }
    }
  }
}

Tools

No tools detected

We auto-extract tools from the README. The maintainer can list them under a ## Tools heading to populate this section.

Overview

What is OceanBase Kubernetes Control Tool (okctl) MCP Server?

It is an MCP server implementation that exposes OceanBase cluster, tenant, and backup policy management tools via the MCP protocol by calling the underlying okctl command-line tool. It is intended for users who manage OceanBase clusters on Kubernetes.

How to use OceanBase Kubernetes Control Tool (okctl) MCP Server?

Requires Python 3.10+, the uv package manager, and a properly installed and configured okctl and Kubernetes environment. Configure the server in your MCP client JSON, setting the OB_CLUSTER_PASSWORD environment variable. Optional command-line arguments include --tools to enable specific modules, --use_sse for SSE transport, and --port to set the SSE port (default 8000).

Key features of OceanBase Kubernetes Control Tool (okctl) MCP Server

Cluster management: create, delete, view, scale, update, upgrade clusters
Tenant management: create, delete, view, scale, update, upgrade, change password, activate standby, replay logs, switchover
Backup policy management: create, delete, view, update, pause, resume policies
SQL operations: configure database connection and execute SQL queries
Component management: list, install, and update components

Use cases of OceanBase Kubernetes Control Tool (okctl) MCP Server

Automate OceanBase cluster lifecycle operations on Kubernetes
Manage tenants including primary/standby switchover and log replay
Configure and control backup policies for OceanBase clusters
Execute SQL queries against OceanBase databases programmatically
Install and update OceanBase-related components

FAQ from OceanBase Kubernetes Control Tool (okctl) MCP Server

What are the runtime dependencies?

Python 3.10 or higher, uv, okctl (properly installed and configured), and a Kubernetes environment with access to OceanBase clusters.

Where does the server store data and how is authentication handled?

Data resides in the Kubernetes cluster where OceanBase is deployed. Authentication for SQL operations uses the environment variable OB_CLUSTER_PASSWORD or a password parameter in the connection configuration.

Which transports are supported?

By default it uses stdio transport. You can enable Server-Sent Events (SSE) transport with the --use_sse flag and optionally set a custom port.

Are there any known limits?

Some operations (e.g., deleting clusters, deleting tenants) may be irreversible; proceed with caution. SQL queries require precise prompts to avoid errors. It is recommended to perform backups before executing important operations.

What tools can be enabled selectively?

Use the --tools argument with a comma‑separated list from: all, clusters, tenants, backup_policy, components, sql. Default is all tools enabled.