autourgos-cua-mouse-click-tool

Mouse click tool for Autourgos computer-use agents. Left- or right-click at a given pixel position -- typically the coordinates returned by autourgos-cua-coordinate-tool.

There are two ways to use this package -- pick one:

Table of Contents

• Install
• Use Case 1: click_mouse() (library)
• Use Case 2: MouseClickTool (agent tool)
• Error Handling
• API Reference
• License

Install

pip install autourgos-cua-mouse-click-tool

Uses pyautogui under the hood to perform the actual click -- installed automatically as a dependency.

Use Case 1: click_mouse() (library)

Call it directly from your own code.

from autourgos_cua_mouse_click_tool import click_mouse

click_mouse(500, 300)              # left click at (500, 300)
click_mouse(500, 300, "right")     # right click at (500, 300)
click_mouse(500, 300, clicks=2)    # double left-click

Use Case 2: MouseClickTool (agent tool)

For autourgos-agent. No constructor arguments needed -- hand it straight to agent.add_tools(...).

from autourgos_agent import Agent
from autourgos_cua_mouse_click_tool import MouseClickTool

agent = Agent(llm=my_llm)
agent.add_tools(MouseClickTool())

result = agent.invoke("Click the Submit button at (512, 780)")

Often paired with autourgos-cua-coordinate-tool's CoordinateFinderTool, so the agent first finds where an element is, then clicks it:

from autourgos_cua_coordinate_tool import CoordinateFinderTool
from autourgos_cua_mouse_click_tool import MouseClickTool

agent.add_tools(CoordinateFinderTool(my_llm), MouseClickTool())
result = agent.invoke("Find and click the Submit button")

It returns a dict:

{"clicked": True, "x": 512, "y": 780, "button": "left"}
# or, on failure:
{"clicked": False, "error": "..."}

Error Handling

click_mouse() raises ClickError -- never silently does nothing -- when:

• button isn't "left" or "right",
• the pyautogui dependency is unavailable, or
• the underlying click call itself fails (e.g. no display/desktop session).

MouseClickTool's wrapped call catches ClickError and returns {"clicked": False, "error": "..."} instead of raising, so a calling agent gets a structured result rather than a crash.

API Reference

click_mouse(x, y, button="left", *, clicks=1) -> None

• x, y: pixel coordinates to click at.
• button: "left" or "right".
• clicks: number of clicks to perform (e.g. 2 for a double-click).

Raises ClickError on failure.

MouseClickTool() -> Tool

A click_mouse(x, y, button) tool with a fixed name (click_mouse) and description stating it supports both left and right clicks. Ready for agent.add_tools(...).

License

Apache License 2.0. See LICENSE.