Skip to main content
Glama
Sign In
vmware-vks

vmware-vks

by vmware-skills
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Remote

get_tkc_cluster

Read-onlyIdempotent

Retrieve detailed status for a single Tanzu Kubernetes Cluster by name and namespace. Poll it after create, scale, or upgrade operations to confirm async changes land.

Instructions

[READ] Get detailed status for a single TKC cluster.

Returns one object, not the list envelope: name, namespace, phase, k8s_version, control_plane_replicas, worker_pools, worker_replica_total (null if any pool is autoscaled or unknown), conditions, infrastructure_ready, control_plane_ready. The legacy worker_replicas field names only the first pool. Run list_tkc_clusters first — a TKC name is only unique within one namespace. Poll this after create_tkc_cluster, scale_tkc_cluster or upgrade_tkc_cluster to watch an async change land.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>",
      "namespace": "<namespace>"
    },
    "name": "get_tkc_cluster"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesCluster name (via list_tkc_clusters).
targetNovCenter in config.yaml; omit for the default.
namespaceYesNamespace holding it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv1.8.14
    • addedInput schema / additionalProperties
      Added value: +false
    • addedInput schema / properties / name / description
      Added value: +"Cluster name (via list_tkc_clusters)."
    • addedInput schema / properties / namespace / description
      Added value: +"Namespace holding it."
    • addedInput schema / properties / target / description
      Added value: +"vCenter in config.yaml; omit for the default."
  2. Addedv1.8.9
  3. Removedv1.8.8
  4. Addedv1.5.26
  5. Removedv1.5.23
  6. First observedv1.3.2

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already establish readOnly, idempotent, non-destructive and open-world, so the safety profile is covered; the description adds genuinely new behavioral context such as the single-object return shape, the null semantics of worker_replica_total (autoscaled or unknown), and the legacy worker_replicas caveat. It stops short of describing error behavior (e.g. not-found in the wrong namespace) or permission requirements, which keeps it off a 5.

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 read-only marker and one-line purpose are front-loaded, followed by return shape, a caveat, and prerequisite/polling guidance in short declarative clauses. No sentence is filler; each adds a distinct fact an agent needs.

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?

With no output schema, the description carries the return contract itself and does so by enumerating the fields (phase, k8s_version, control_plane_replicas, worker_pools, conditions, readiness flags) and flagging the ambiguous one. Combined with the async-polling note, an agent has everything needed to call it and interpret the result.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds meaning beyond the schema: it explains that name is only unique within a namespace, implying the required name+namespace pairing, and points at list_tkc_clusters as the source of a valid name. It says nothing about the optional target parameter, which stays purely schema-documented.

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?

"[READ] Get detailed status for a single TKC cluster" gives a specific verb (get), resource (TKC cluster) and scope (single, not a list). It immediately distinguishes itself from the plural sibling list_tkc_clusters by noting it returns one object rather than the list envelope.

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?

It names the prerequisite and the alternative explicitly: "Run list_tkc_clusters first — a TKC name is only unique within one namespace." It also states a concrete use case ("Poll this after create_tkc_cluster, scale_tkc_cluster or upgrade_tkc_cluster to watch an async change land"), so the agent knows both when to reach for it and what it replaces.

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

Deploy Server

Other Tools