Host and Endpoint Configuration

[abrichr]

OmniMCP separates the concepts of host (where UI automation runs) and endpoint (where results are sent), enabling flexible deployment scenarios:

Basic Configuration

# Local execution with local endpoint (default)
omni = Omni()  # Implies host="localhost", endpoint is local

# Remote host, local endpoint
omni = Omni(host="remote-machine.example.com")

# Local host, remote endpoint
omni = Omni(endpoint="api.example.com:1024")

# Remote host and remote endpoint
omni = Omni(
    host="automation-target.corp",
    endpoint="omni.api"
)

Advanced Host Configuration

# SSH connection to remote host
omni = Omni(
    host="192.168.1.100", 
    host_protocol="ssh",
    host_auth={"username": "user", "key_path": "~/.ssh/id_rsa"}
)

# RDP connection to Windows host
omni = Omni(
    host="windows-server.corp", 
    host_protocol="rdp",
    host_auth={"username": "admin", "password": "secure_password"}
)

Advanced Endpoint Configuration

# Local API endpoint with custom port
omni = Omni(endpoint="localhost:1024")

# Cloud service endpoint with authentication
omni = Omni(
    endpoint="omni.api",
    api_key="YOUR_API_KEY"
)

Use Cases

• Fleet Management: Automate UIs across multiple machines while aggregating results centrally
• Cross-Platform: Run automation on Windows, macOS, or Linux hosts from any control system
• Headless Execution: Perform UI automation on server environments with no display
• Security Isolation: Keep sensitive automation targets isolated while sending sanitized results elsewhere