Skip to main content
Glama

get_supervisor_status

Read-onlyIdempotent

Check Supervisor Cluster status to confirm it is running before creating namespaces or TKC clusters. Returns cluster ID, config status, Kubernetes status, API endpoint, version, network provider.

Instructions

[READ] Get the status of one Supervisor Cluster (vSphere with Tanzu control plane).

Returns cluster_id, config_status (RUNNING = healthy, CONFIGURING, ERROR, REMOVING), kubernetes_status (READY / WARNING / ERROR), api_server_cluster_endpoint (Supervisor K8s API address), kubernetes_version (from the software/clusters endpoint; null plus a kubernetes_version_hint if that call fails), and network_provider. Read-only. Run check_vks_compatibility first to discover cluster IDs; use this to verify a Supervisor is healthy before creating namespaces or TKC clusters on it.

Args: cluster_id: Compute cluster MoRef ID, e.g. 'domain-c1' (from the wcp_clusters field of check_vks_compatibility). target: Name of a vCenter entry in ~/.vmware-vks/config.yaml. Omit to use the default target defined in that file.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
targetNo
cluster_idYes
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations declare readOnlyHint=true, destructiveHint=false, idempotentHint=true. The description reinforces read-only behavior and adds details: kubernetes_version may be null with a hint if the call fails. No contradictions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with '[READ]', efficiently organized with bullet-like lists for return fields and args. Every sentence adds value, no waste, and it's well-structured for an agent to parse.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema, the description thoroughly explains all returned fields and a potential edge case (null version). It references the prerequisite sibling tool and provides complete guidance for effective use.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema has 0% coverage, but the description gives detailed meaning for both parameters: cluster_id is a MoRef ID with example 'domain-c1' and source field, target is a config file entry with default behavior. This fully compensates for the missing schema descriptions.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool gets the status of a Supervisor Cluster, listing specific returned fields like cluster_id, config_status, kubernetes_status, etc. It uses the verb 'Get' and distinguishes from sibling tools like check_vks_compatibility (which discovers cluster IDs).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly advises to run check_vks_compatibility first to discover cluster IDs, and to use this tool to verify health before creating namespaces or TKC clusters. It provides clear context for when and why to use the tool.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/zw008/VMware-VKS'

If you have feedback or need assistance with the MCP directory API, please join our Discord server