Skip to main content
Glama
heresun

OrbStack MCP Server

by heresun

orbstack_k8s_stop

Idempotent

Stop the Kubernetes cluster in OrbStack to conserve system resources on macOS. This tool halts all cluster operations through the OrbStack MCP Server.

Instructions

停止 OrbStack 的 Kubernetes 集群。

Returns: str: 停止结果

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The handler function 'orbstack_k8s_stop' which calls 'orbstack k8s stop' via '_run_orb' and returns the result.
    @mcp.tool(
        name="orbstack_k8s_stop",
        annotations={
            "title": "停止 Kubernetes",
            "readOnlyHint": False,
            "destructiveHint": False,
            "idempotentHint": True,
            "openWorldHint": False,
        },
    )
    async def orbstack_k8s_stop() -> str:
        """停止 OrbStack 的 Kubernetes 集群。
    
        Returns:
            str: 停止结果
        """
        code, stdout, stderr = await _run_orb(["k8s", "stop"])
        if code != 0:
            return _format_error(stderr)
        return "Kubernetes 集群已停止" + (f"\n{stdout}" if stdout else "")
Behavior3/5

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

Annotations provide key behavioral hints: readOnlyHint=false (implies mutation), idempotentHint=true (safe to retry), destructiveHint=false (non-destructive). The description adds minimal context by specifying it stops the Kubernetes cluster, but doesn't elaborate on effects (e.g., what happens to running pods) or operational details. With annotations covering core traits, the description adds some value but lacks depth.

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

Conciseness3/5

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

The description is brief but includes an extra 'Returns:' section that merely repeats what the output schema would cover ('str: 停止结果'), adding redundancy. The core purpose is stated in one clear sentence, but the return statement is wasteful given the presence of an output schema.

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, annotations cover key behaviors, output schema exists), the description is reasonably complete. It states what the tool does, and with annotations and output schema, the agent has sufficient context. However, it could benefit from more operational guidance (e.g., idempotency note) to reach a 5.

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). The description doesn't need to explain parameters, so it appropriately focuses on the action. A baseline of 4 is justified as the description handles the parameter-less case adequately without unnecessary detail.

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 action ('停止' meaning 'stop') and target resource ('OrbStack 的 Kubernetes 集群' meaning 'OrbStack's Kubernetes cluster'), providing a specific verb+resource combination. However, it doesn't explicitly differentiate from sibling tools like 'orbstack_k8s_start' or 'orbstack_stop' beyond the Kubernetes focus, which is why it doesn't reach a perfect 5.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., cluster must be running), when-not-to-use scenarios, or comparisons to related tools like 'orbstack_k8s_start' or general 'orbstack_stop'. The agent must infer usage from the name and context alone.

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