Skip to main content
Glama
heresun

OrbStack MCP Server

by heresun

orbstack_k8s_status

Read-onlyIdempotent

Check the status of Kubernetes clusters running in OrbStack on macOS to monitor cluster health and availability.

Instructions

查看 OrbStack Kubernetes 集群的状态。

Returns: str: K8s 集群状态

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The handler function that executes the `orbstack k8s status` command to retrieve the status of the Kubernetes cluster.
    async def orbstack_k8s_status() -> str:
        """查看 OrbStack Kubernetes 集群的状态。
    
        Returns:
            str: K8s 集群状态
        """
        code, stdout, stderr = await _run_orb(["k8s", "status"])
        if code != 0:
            return _format_error(stderr)
        return f"Kubernetes 状态:\n{stdout}" if stdout else "Kubernetes 状态: 未运行"
  • The registration decorator that defines the `orbstack_k8s_status` tool in the MCP server.
    @mcp.tool(
        name="orbstack_k8s_status",
        annotations={
            "title": "Kubernetes 状态",
            "readOnlyHint": True,
            "destructiveHint": False,
            "idempotentHint": True,
            "openWorldHint": False,
        },
Behavior3/5

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

Annotations already provide rich behavioral information: readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=false. The description adds minimal value beyond this, only stating it returns a string status. It doesn't contradict annotations (the description aligns with read-only behavior), but provides little additional context about what the status string contains, format, or interpretation.

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

Conciseness4/5

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

The description is brief and front-loaded with the core purpose in the first sentence. The second sentence about return type is somewhat redundant given the output schema exists, but it's not excessive. Overall efficient with minimal waste, though the return statement could potentially be omitted since output schema exists.

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

Completeness4/5

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

Given the tool's simplicity (0 parameters, rich annotations, output schema exists), the description is reasonably complete. It states what the tool does, and the annotations cover safety and behavioral aspects. The output schema handles return value documentation. The main gap is lack of guidance on when to use versus sibling tools, but for such a simple diagnostic tool, the description is adequate.

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?

The tool has 0 parameters, and schema description coverage is 100% (though trivial since there are no parameters). With no parameters to document, the description appropriately doesn't discuss parameters. A baseline of 4 is appropriate for zero-parameter tools where the schema fully covers the empty parameter set.

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

Purpose4/5

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

The description clearly states the tool's purpose: '查看 OrbStack Kubernetes 集群的状态' (view OrbStack Kubernetes cluster status). It specifies both the verb (view/check) and the resource (Kubernetes cluster status), and distinguishes it from sibling tools like orbstack_k8s_start and orbstack_k8s_stop. However, it doesn't explicitly differentiate from the general orbstack_status tool, which might check overall OrbStack status rather than specifically Kubernetes.

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

Usage Guidelines3/5

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

The description implies usage context (checking Kubernetes cluster status) but provides no explicit guidance on when to use this tool versus alternatives like orbstack_status or orbstack_k8s_start/stop. There's no mention of prerequisites, typical use cases, or when not to use it. The context is clear but lacks sibling differentiation guidance.

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/heresun/orbstack-mcp'

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