Skip to main content
Glama
heresun

OrbStack MCP Server

by heresun

orbstack_docker_pull

Idempotent

Pull Docker images from container registries to your local system using the OrbStack MCP Server. Specify the image name to download and prepare containers for deployment.

Instructions

从镜像仓库拉取 Docker 镜像。

Args: params: 包含镜像名称

Returns: str: 拉取结果

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
paramsYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Implementation Reference

  • The 'orbstack_docker_pull' handler executes the docker pull command.
    async def orbstack_docker_pull(params: DockerImageInput) -> str:
        """从镜像仓库拉取 Docker 镜像。
    
        Args:
            params: 包含镜像名称
    
        Returns:
            str: 拉取结果
        """
        code, stdout, stderr = await _run_docker(["pull", params.image], timeout=300)
        if code != 0:
            return _format_error(stderr, "请检查镜像名称是否正确")
        return f"镜像 '{params.image}' 拉取成功\n{stdout}"
    
    
    @mcp.tool(
  • The 'orbstack_docker_pull' tool registration using the @mcp.tool decorator.
    @mcp.tool(
        name="orbstack_docker_pull",
        annotations={
            "title": "拉取 Docker 镜像",
            "readOnlyHint": False,
            "destructiveHint": False,
            "idempotentHint": True,
            "openWorldHint": True,
        },
    )
  • The input schema for 'orbstack_docker_pull' defined as DockerImageInput.
    class DockerImageInput(BaseModel):
        """Docker 镜像相关输入"""
        model_config = ConfigDict(str_strip_whitespace=True, extra="forbid")
    
        image: str = Field(
            ...,
            description="镜像名称,如 nginx:latest, ubuntu:22.04",
Behavior3/5

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

Annotations provide rich information: readOnlyHint=false (write operation), openWorldHint=true (can pull from any registry), idempotentHint=true (safe to retry), destructiveHint=false (non-destructive). The description adds minimal behavioral context beyond this, only stating it pulls from a '镜像仓库' (image registry). It doesn't contradict annotations, but offers little extra value like rate limits, auth needs, or what happens on failure.

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 not optimally structured. The first sentence states the purpose clearly, but the 'Args:' and 'Returns:' sections are redundant since the input and output schemas already document these. This adds unnecessary length without new information. However, it's not verbose, just inefficiently organized.

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 moderate complexity (a write operation with idempotency), rich annotations, and existing output schema, the description is minimally adequate. It covers the basic purpose but lacks context on error handling, performance, or integration with sibling tools. The annotations and schemas carry most of the load, making the description's gaps less critical but still present.

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?

Schema description coverage is 0%, so the description must compensate. It mentions '包含镜像名称' (contains image name), which aligns with the 'image' parameter in the schema, but provides no additional semantics like format examples (beyond what's in the schema), registry defaults, tag behavior, or authentication requirements. The schema already documents the image parameter well, but the description adds almost nothing beyond restating the parameter exists.

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 verb ('拉取' - pull) and resource ('Docker 镜像' - Docker image), making the purpose immediately understandable. However, it doesn't explicitly differentiate this tool from sibling tools like 'orbstack_docker_run' or 'orbstack_machine_pull', which might also involve pulling operations. The purpose is clear but lacks sibling differentiation.

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. There's no mention of prerequisites (e.g., needing Docker installed or OrbStack running), when to choose this over 'orbstack_docker_run' (which might implicitly pull), or any constraints. The agent must infer usage from 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