omnidebuglink

# OmniDebugLink

**Remote debugging and automated testing on real devices — from anywhere.**

Add a small client SDK to your app, connect it with a device token, and any AI coding tool
(Claude Code, Cursor, Codex, Gemini CLI, …) can inspect and drive the running app over
[Model Context Protocol](https://modelcontextprotocol.io): dump the UI tree, take screenshots,
tap, swipe, type, read logs, measure performance — no USB cable, no shared network, no emulator.

```
Your App ──wss──> OmniDebugLink relay ──MCP──> AI coding tool
```

- One outbound WebSocket from the device — works across networks, behind NAT, on real hardware.
- The AI side sees plain MCP tools: `list_devices` → `run_task` / `device_status` / `list_tasks` …
- One token pair = one device seat. Tokens are per-device; never embed one in
  a release build — release use goes through the
  [conditional pattern](sdk-integration.md#production--conditional-debugging).

## Client SDKs

| Platform | Install | Repo |
|---|---|---|
| Unity | Package Manager → add from git URL | [omnidebuglink_unity](https://github.com/omnidebuglink/omnidebuglink_unity) |
| Android | JitPack: `com.github.omnidebuglink:omnidebuglink_android:<tag>` | [omnidebuglink_android](https://github.com/omnidebuglink/omnidebuglink_android) |
| Flutter | pubspec git dependency (`ref:` tag) | [omnidebuglink_flutter](https://github.com/omnidebuglink/omnidebuglink_flutter) |
| iOS / macOS | Swift Package (iOS 15+ / macOS 12+) | [omnidebuglink_apple_swift](https://github.com/omnidebuglink/omnidebuglink_apple_swift) |
| React Native | `npm i omnidebuglink/omnidebuglink_react_native#<tag>` | [omnidebuglink_react_native](https://github.com/omnidebuglink/omnidebuglink_react_native) |
| Godot | copy the `addons/omni_debug_link/` folder (Godot ≥ 4.2) | [omnidebuglink_godot](https://github.com/omnidebuglink/omnidebuglink_godot) |
| Web | CDN build via jsDelivr (`@<tag>`) | [omnidebuglink_web](https://github.com/omnidebuglink/omnidebuglink_web) |

Each SDK repo has the full install steps and task tables for its platform.
Pin a version tag (`#vX.Y.Z` / `ref:` / `@vX.Y.Z`) in production hosts.

## Quickstart

1. **Create a device token pair** at the [console](https://www.omnidebuglink.dev/console)
   (free during the public beta).
2. **Connect your app**: add the SDK for your platform and start it with the
   token — freely in debug builds; in release builds only via the
   [conditional pattern](sdk-integration.md#production--conditional-debugging)
   (runtime-issued token, never embedded).
3. **Add the MCP server** to your AI tool (OAuth login in the browser):

   ```bash
   claude mcp add --transport http odl https://api.omnidebuglink.dev/mcp
   ```

   Works with any MCP client: Cursor, Codex CLI, Gemini CLI, …
4. Ask the AI to `list_devices` and start driving the device.

## Integrating an SDK into your app

[sdk-integration.md](sdk-integration.md) is written to be handed to your AI
coding tool verbatim — per-platform install and connect snippets, the rules
that must not be broken, and a verification checklist. Ask the agent to read
it and wire the SDK in.

## Building a client for another platform?

Any platform with a WebSocket client can join — the wire protocol is a single JSON frame format:

→ **[Third-Party Client Development Guide](third-party-client-guide.md)** — protocol spec,
a portable reference implementation, known pitfalls, and a pre-deployment verification
checklist. AI coding agents can implement a compliant client from this guide alone,
without reading any SDK source.

## Links

- [Website](https://www.omnidebuglink.dev) · [Console](https://www.omnidebuglink.dev/console)
- [Third-party client guide](third-party-client-guide.md)
- SDK repositories: see the table above