Skip to main content
Glama
heresun

OrbStack MCP Server

by heresun

orbstack_version

Read-onlyIdempotent

Retrieve the current OrbStack version to verify software compatibility and ensure proper functionality for managing Docker containers, Linux VMs, and Kubernetes clusters on macOS.

Instructions

获取 OrbStack 版本号。

Returns: str: OrbStack 版本信息

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The handler function that executes the 'orbstack_version' tool.
    async def orbstack_version() -> str:
        """获取 OrbStack 版本号。
    
        Returns:
            str: OrbStack 版本信息
        """
        code, stdout, stderr = await _run_orb(["version"])
        if code != 0:
            return _format_error(stderr)
        return f"OrbStack 版本: {stdout}"
  • The registration of the 'orbstack_version' tool using the @mcp.tool decorator.
    @mcp.tool(
        name="orbstack_version",
        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 declare readOnlyHint=true, destructiveHint=false, idempotentHint=true, and openWorldHint=false, covering safety and idempotency. The description adds value by specifying the return type ('str: OrbStack 版本信息'), which clarifies the output format beyond annotations. No contradictions with annotations exist.

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 extremely concise and well-structured: one sentence for the purpose and one for the return value. Every sentence adds essential information without redundancy, making it easy for an agent to parse quickly.

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 safety, output schema exists), the description is largely complete. It states the purpose and return type. However, it lacks context on when to use this versus similar tools like 'orbstack_status', which slightly reduces completeness for agent decision-making.

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%. With no parameters to document, the description doesn't need to compensate. It appropriately focuses on the tool's purpose and return value, earning a high baseline score for parameter semantics.

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 version number). It uses a specific verb ('获取') and resource ('OrbStack 版本号'), making the intent unambiguous. However, it doesn't explicitly differentiate from sibling tools like 'orbstack_status' which might also provide version information, preventing a perfect score.

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_status' that might overlap in functionality, nor does it specify prerequisites or appropriate contexts for version checking. This leaves the agent without usage direction.

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