Skip to main content

Python client library for the Smooth Operator agent tools API.

Project description

If you are looking for the MCP server: find it here.

If you are looking for the Python Library, go on.. ;)

Smooth Operator Agent Tools - Python Library

This is the official Python library implementation for Smooth Operator Agent Tools, a state-of-the-art toolkit for programmers developing Computer Use Agents on Windows systems.

Overview

The Smooth Operator Agent Tools are a powerful toolkit that handles the complex tasks of interacting with the Windows Automation Tree and Playwright browser control, while providing advanced AI functions such as identifying UI elements through screenshots and textual descriptions.

This Python library provides a convenient wrapper around the Smooth Operator Tools Server API, allowing you to easily integrate these capabilities into your Python applications.

All features can be tested and explored through a convenient Windows user interface before implementing them in code. Try them out at Smooth Operator Tools UI.

Installation

pip install smooth-operator-agent-tools

Prerequisites

Google Chrome

The Smooth Operator Agent Tools library requires Google Chrome (or a compatible Chromium-based browser) to be installed on the system for browser automation features to work.

Server Installation

The Smooth Operator client library includes a server component that needs to be installed in your application data directory. The server files are packaged with the library and will be automatically extracted on first use.

First-Time Execution

When you first use the library, it will automatically:

  1. Create the directory %APPDATA%\SmoothOperator\AgentToolsServer (or the equivalent on your OS)
  2. Extract the server files from the package
  3. Start the server process

Note that for Chrome automation features to work, you need to ensure Node.js and Playwright are installed as described in the Prerequisites section.

For Application Installers

If you're building an application installer that includes this library, you should include steps to install Node.js and Playwright during your application's installation process for better user experience. See the Prerequisites section for the required installation steps.

Usage

from smooth_operator_agent_tools import SmoothOperatorClient

# Initialize the client with your API key, get it for free at https://screengrasp.com/api.html
client = SmoothOperatorClient(api_key="YOUR_API_KEY")

# Start the Server - this takes a moment
client.start_server()

# Take a screenshot
screenshot = client.screenshot.take()

# Get system overview
overview = client.system.get_overview()

# Perform a mouse click
client.mouse.click(500, 300)

# Find and click a UI element by description
client.mouse.click_by_description("Submit button")

# Type text
client.keyboard.type("Hello, world!")

# Control Chrome browser
client.chrome.open_chrome("https://www.example.com")
client.chrome.get_dom()

# You can also use the to_json_string() method on many objects
# to get a JSON string that can easily be used in a prompt to a LLM
# to utilize AI even more for automated decision making

Features

  • Screenshot and Analysis: Capture screenshots and analyze UI elements
  • Mouse Control: Precise mouse operations using coordinates or AI-powered element detection
  • Keyboard Input: Type text and send key combinations
  • Chrome Browser Control: Navigate, interact with elements, and execute JavaScript
  • Windows Automation: Interact with Windows applications and UI elements
  • System Operations: Open applications and manage system state

Documentation

For detailed API documentation, visit:

  • Usage Guide: Detailed examples and explanations for common use cases.
  • Example Project: Download, follow step by step instructions and have your first automation running in mintes.
  • Documentation: Detailed documentation of all the API endpoints of the server that is doing the work internally.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

smooth_operator_agent_tools-1.0.112.tar.gz (66.4 MB view details)

Uploaded Source

Built Distribution

smooth_operator_agent_tools-1.0.112-py3-none-any.whl (66.4 MB view details)

Uploaded Python 3

File details

Details for the file smooth_operator_agent_tools-1.0.112.tar.gz.

File metadata

File hashes

Hashes for smooth_operator_agent_tools-1.0.112.tar.gz
Algorithm Hash digest
SHA256 6b6d5a13d8e8db4259e86984ada9f7c28b3aa11ed67aba697016429c89c566dd
MD5 6d61578e27f7fe7d1af1acee7177bcb9
BLAKE2b-256 95db3c413ee5a18871761e4a0b88df547a76549f331ac948cfa36e4003c42158

See more details on using hashes here.

File details

Details for the file smooth_operator_agent_tools-1.0.112-py3-none-any.whl.

File metadata

File hashes

Hashes for smooth_operator_agent_tools-1.0.112-py3-none-any.whl
Algorithm Hash digest
SHA256 02d8b39377ffe7515a38c06f5aa38a5db0cc775f8271bf1e5a25d8d6daa6689b
MD5 e2823f68ec3364a8db7dba5f98cc0165
BLAKE2b-256 2668b7b862c2612f7524278b9358de210a419670efb7aa0909500b83d44f7265

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page