Skip to content

Visual Highlighting

✅ Implemented 🧪 Tested 🤖 Android Only

Expose visual highlight overlays (box or circle) as an MCP tool for debugging UI layout and state.

See the Status Glossary for chip definitions.

MCP Tool

  • highlight
  • Params:
    • shape: required highlight shape definition
    • Optional description
    • platform: android | ios
    • Optional device targeting: deviceId, device, sessionUuid
    • Optional timeoutMs override
  • Returns: success flag and optional error message.
  • iOS: returns an unsupported error (Android only for now).
  • Highlights auto-remove after their animation completes.

Examples

Highlight element during bug report

javascript await highlight({ shape: { type: "box", bounds: { x: 100, y: 200, width: 300, height: 150 }, style: { strokeColor: "#FF0000", strokeWidth: 3 } }, platform: "android" });

Generate bug report with highlights

javascript await bugReport({ platform: "android", includeScreenshot: true, highlights: [ { description: "Expected button location", shape: { type: "box", bounds: { x: 120, y: 280, width: 220, height: 90 }, style: { strokeColor: "#FF0000", strokeWidth: 6 } } } ], includeHighlightsInScreenshot: true });

Multiple highlights for comparison

```javascript await highlight({ shape: { type: “circle”, bounds: { x: 200, y: 300, width: 50, height: 50 }, style: { strokeColor: “#00FF00”, strokeWidth: 3 } }, platform: “android” });

await highlight({ shape: { type: “circle”, bounds: { x: 210, y: 310, width: 50, height: 50 }, style: { strokeColor: “#FF0000”, strokeWidth: 3 } }, platform: “android” }); ```

Response Format

typescript { success: boolean; error?: string; }