Clusters Tools
File: mcp_admin_console/tools/clusters.py
Tools for listing, describing, and diagnosing BYOC clusters.
List and Describe
| Tool | Parameters | Description |
|---|---|---|
list_clusters | cluster_name, account_id, region_id, sr_version, limit, offset | List clusters with filters. Returns name, ID, account, region, status, VM specs |
list_clusters_simple | limit, offset | Simplified cluster list (less detail, faster) |
describe_cluster | cluster_id | Full cluster detail -- region, VMs, network, storage, config, state |
describe_instance | cluster_id, vm_id | Describe a specific VM instance |
Cluster Operations
| Tool | Parameters | Description |
|---|---|---|
get_cluster_infra_operations | cluster_id | Infrastructure operations history (CREATE, RESUME, SUSPEND, etc.) |
get_cluster_behavior | cluster_id, behavior_id | Details of a specific cluster behavior/operation |
get_region_behaviors | cluster_id | Regional cluster behaviors (operations from region service) |
get_runtime_variables | cluster_id | StarRocks runtime variables |
list_cluster_config | cluster_id | FE/BE/CN configuration keys and values |
get_clusters_by_release | release_key | Find clusters running a specific StarRocks version |
get_clusters_by_ami | ami_id | Find clusters using a specific AMI |
Query History
| Tool | Parameters | Description |
|---|---|---|
get_query_users | cluster_id | Database users who executed queries |
get_query_records | cluster_id, start_time, end_time, status, filter_user, warehouse, search, list_size, order_col, order_desc | Query history. Order by startTime, timeUsed, cpuCostNs, or scanRows |
get_query_detail | cluster_id, query_id | Full detail for a specific query -- SQL, timing, rows, CPU/mem cost |
Diagnostics
| Tool | Parameters | Description |
|---|---|---|
read_cluster_file | cluster_id, vm_id, path | Read a file from a cluster VM |
get_cluster_dmesg | cluster_id, vm_id | Kernel log (dmesg) -- useful for OOM kills, hardware errors |
get_query_dump | cluster_id | StarRocks query dump |
get_agent_settings | cluster_id | CelerData agent settings |
get_backup_log_config | cluster_id | Backup log configuration |
list_target_groups | cluster_id | NLB target groups |
Coredump and Debug
| Tool | Parameters | Description |
|---|---|---|
check_vm_coredump_state | cluster_id, vm_id | Check if coredump collection is enabled |
list_vm_coredump_files | cluster_id, vm_id | List coredump files |
list_vm_debuginfo_files | cluster_id, vm_id | List debug info files |
get_instance_serial_console | cluster_id, vm_id | Serial console output from a VM |