OrbStack MCP Server

Instructions

Implementation Reference

• src/orbstack_mcp/server.py:1117-1131 (handler)

  The handler function `orbstack_compose_ps` executes the `docker compose ps` command.

  async def orbstack_compose_ps(params: DockerComposeInput) -> str:
      """查看 Docker Compose 项目中各服务的运行状态。
  
      Args:
          params: 包含项目目录
  
      Returns:
          str: 服务状态列表
      """
      args = ["compose", "-f", f"{params.project_dir}/docker-compose.yml", "ps"]
  
      code, stdout, stderr = await _run_docker(args)
      if code != 0:
          return _format_error(stderr)
      return f"Compose 服务状态:\n{stdout}" if stdout else "没有运行中的 Compose 服务"

• src/orbstack_mcp/server.py:1107-1116 (registration)

  Tool registration for `orbstack_compose_ps` using the `@mcp.tool` decorator.

  @mcp.tool(
      name="orbstack_compose_ps",
      annotations={
          "title": "查看 Compose 服务状态",
          "readOnlyHint": True,
          "destructiveHint": False,
          "idempotentHint": True,
          "openWorldHint": False,
      },
  )