okctl-mcp-server

okctl-mcp-server

2

The OceanBase Kubernetes Control Tool MCP Server facilitates the management of OceanBase clusters and resources, including tenants and backup policies. It provides comprehensive tooling within the MCP framework for efficient cluster governance.

OceanBase Kubernetes Control Tool (okctl) MCP Server

Project Overview

This project is the MCP server implementation for the OceanBase Kubernetes Control Tool, providing functions for managing OceanBase clusters, tenants, and backup policies through the MCP protocol.

Functional Modules

  • Cluster Management: Manage OceanBase clusters including creation, deletion, scaling, updating, and upgrading.
  • Tenant Management: Handle creation, deletion, and management of OceanBase tenants.
  • Backup Policy Management: Manage OceanBase backup policies including creation, deletion, and updates.
  • SQL Operations: Configure database connections and execute SQL queries on OceanBase clusters.
  • Component Management: Install, update, and manage OceanBase components.

Development Environment Setup

  • Requires Python 3.10+, uv package manager, and OceanBase Kubernetes Control Tool (okctl).
  • Configured Kubernetes environment with control over OceanBase clusters.

Command Line

  • --tools: Specify enabled tools (all, clusters, tenants, backup_policy, components, sql).
  • --use_sse: Enable Server-Sent Events transport.
  • --port: Port for SSE transport, default 8000.

Important Notes

  • Server operates in environments with Kubernetes cluster access.
  • Functions call the underlying okctl tool.
  • Operations such as deletions may be irreversible.

Contributing

Issues and Pull Requests are welcome.

License

This project is licensed under the Apache 2.0 License.