Skip to main content
Glama
heresun

OrbStack MCP Server

by heresun

orbstack_status

Read-onlyIdempotent

Check OrbStack's operational status and version details to verify its functionality on macOS.

Instructions

获取 OrbStack 的运行状态信息。

返回 OrbStack 是否正在运行、版本等基本状态。

Returns: str: OrbStack 状态信息

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The handler function `orbstack_status` executes the `orb status` command and returns the output.
    async def orbstack_status() -> str:
        """获取 OrbStack 的运行状态信息。
    
        返回 OrbStack 是否正在运行、版本等基本状态。
    
        Returns:
            str: OrbStack 状态信息
        """
        code, stdout, stderr = await _run_orb(["status"])
        if code != 0:
            return _format_error(stderr, "请确认 OrbStack 已安装: brew install orbstack")
        return f"OrbStack 状态:\n{stdout}"
  • Registration of the `orbstack_status` tool using the @mcp.tool decorator.
    @mcp.tool(
        name="orbstack_status",
        annotations={
            "title": "OrbStack 状态查询",
            "readOnlyHint": True,
            "destructiveHint": False,
            "idempotentHint": True,
            "openWorldHint": False,
        },
    )
Behavior4/5

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

Annotations already provide readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=false, covering safety and idempotency. The description adds context by specifying what information is returned ('是否正在运行、版本等基本状态' - whether it's running, version, etc.), which helps the agent understand the output format. No contradictions with annotations.

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 front-loaded with the purpose in the first sentence, followed by details on return values. It's concise with two sentences in Chinese and one in English, but the English 'Returns: str: OrbStack 状态信息' is redundant with the Chinese text, slightly reducing efficiency.

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 low complexity (0 parameters, annotations cover safety, output schema exists), the description is mostly complete. It explains what information is returned, and the output schema handles return values. However, it lacks usage context compared to siblings, which is a minor gap.

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%. The description doesn't need to explain parameters, so it meets the baseline. It implicitly confirms no inputs are required by not mentioning any, which is appropriate for this parameterless tool.

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 的运行状态信息' (Get OrbStack's running status information). It specifies the verb '获取' (get) and resource 'OrbStack 运行状态信息' (OrbStack running status information), distinguishing it from sibling tools like orbstack_start or orbstack_stop. However, it doesn't explicitly differentiate from orbstack_k8s_status, which might cause confusion.

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 sibling tools like orbstack_k8s_status for Kubernetes status or orbstack_version for version info, nor does it specify prerequisites or exclusions. The agent must infer usage from the purpose 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