Skip to main content
Glama
heresun

OrbStack MCP Server

by heresun

orbstack_machine_stop

Idempotent

Stop a specific Linux virtual machine in OrbStack on macOS to manage system resources or halt operations.

Instructions

停止指定的 Linux 机器。

Args: params: 包含机器名称

Returns: str: 停止结果

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
paramsYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The handler function `orbstack_machine_stop` which executes the orb command to stop a machine.
    async def orbstack_machine_stop(params: MachineNameInput) -> str:
        """停止指定的 Linux 机器。
    
        Args:
            params: 包含机器名称
    
        Returns:
            str: 停止结果
        """
        code, stdout, stderr = await _run_orb(["stop", params.name])
        if code != 0:
            return _format_error(stderr)
        return f"机器 '{params.name}' 已停止"
  • The MCP tool registration for `orbstack_machine_stop`.
    @mcp.tool(
        name="orbstack_machine_stop",
        annotations={
            "title": "停止 Linux 机器",
            "readOnlyHint": False,
            "destructiveHint": False,
            "idempotentHint": True,
            "openWorldHint": False,
        },
    )
Behavior4/5

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

Annotations provide key behavioral hints: readOnlyHint=false (write operation), idempotentHint=true (safe to retry), destructiveHint=false (non-destructive). The description adds context by specifying it's for Linux machines, which helps clarify scope beyond annotations. No contradictions with annotations are present.

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 structured with Args and Returns sections. However, the content is sparse—the Args section merely repeats the parameter name without elaboration, and the Returns section is vague ('停止结果' meaning 'stop result'). It could be more informative without losing conciseness.

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

Completeness3/5

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

Given the tool's complexity (a write operation with idempotency) and low schema coverage, the description is incomplete. It lacks details on error conditions, side effects, or what the output schema provides. The presence of an output schema mitigates some gaps, but overall context is insufficient.

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

Parameters2/5

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

The input schema has 0% description coverage, so the description must compensate. It only mentions '包含机器名称' ('contains machine name'), which is minimal and doesn't explain format, constraints, or examples. With one undocumented parameter, this is inadequate.

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 the resource ('指定的 Linux 机器' meaning 'specified Linux machine'), making the purpose immediately understandable. However, it doesn't explicitly differentiate from sibling tools like 'orbstack_machine_delete' or 'orbstack_docker_stop', which would be needed for 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 prerequisites (e.g., the machine must be running), exclusions (e.g., cannot stop if in use), or compare to similar tools like 'orbstack_machine_delete' for removal or 'orbstack_stop' for broader system shutdown.

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