For developers Preview

Adapter Protocol

An open, documented local protocol to add your own agent (a preview).

Overview

What is an adapter?

Preview

An adapter connects an AI coding agent or tool to Orbtile so its sessions appear on the keypad.

How adapters work

  • Session state: Reports whether the agent is thinking, running a tool, writing output, idle, waiting for input, or in an error state.
  • Live text: Streams the assistant's latest words directly onto the LCD key as they generate.
  • Attention & alarm: Triggers the agent's alarm colour when user attention or permission is needed.
  • Session identity: Assigns a session name, active model, and subagent count.
Transport

Local Unix-Domain Socket

127.0.0.1

The transport is a local Unix-domain socket. All communication stays strictly on your Mac.

Architecture

  • Zero network footprint: No external servers, no cloud relay, and no telemetry. Communication happens over a local Unix-domain socket on your filesystem.
  • Low latency: State updates and live text stream instantly without network overhead.
  • Simple protocol: JSON-based messages for session registration, state transitions, tool execution, and token streaming.
Documentation

Specification & Guides

Preview

The full adapter protocol specification and example code are currently in preview. Formal documentation is coming soon.

  • Specification of socket discovery, handshake, and message schemas.
  • Sample adapter implementations in Python and Swift.
  • Integration guides for custom CLI agents and IDE extensions.