Troupeby AliveDocsSign in

Reference

Scopes

A caller must hold every scope a procedure lists (AND). A missing or invalid credential is UNAUTHENTICATED; a valid one without the scopes is FORBIDDEN, naming all the required scopes at once. Some procedures need one more scope for part of their input; their summaries say so. Index.

ScopeGrantsProcedures that require it
runtime:readRead the runtime’s health, host and environment checksruntime.status, runtime.hostInfo, runtime.doctor
runtime:adminStop the runtime, sweep leaks, manage pairingsruntime.shutdown, runtime.sweep, pairings.create, pairings.list, pairings.revoke
devices:readObserve devices: sessions, the UI tree, screenshots, traces, files, watch ticketscatalog.deviceTypes, catalog.osVersions, sessions.get, sessions.list, sessions.wait, sessions.events, apps.list, ui.snapshot, ui.query, ui.waitFor, ui.describeAt, media.screenshot, media.startRecording, media.stopRecording, streams.ticket, traces.startChunk, traces.stopChunk, files.get
devices:acquireCreate, keep alive and release sessionssessions.create, sessions.heartbeat, sessions.release
devices:driveAct on a device: input, system settings, launch and open URLs, drive ticketsapps.launch, apps.terminate, apps.openUrl, input.tap, input.doubleTap, input.longPress, input.swipe, input.drag, input.pinch, input.type, input.fill, input.pressKey, input.pressButton, input.scroll, input.setOrientation, input.gesture, input.hideKeyboard, system.setLocation, system.setAppearance, system.getClipboard, system.setClipboard, system.setStatusBar, debug.connect, debug.evaluate
apps:installInstall, uninstall and reset apps, and set their permissionsapps.install, apps.uninstall, apps.clearData, apps.setPermissions
apps:debugRun code in an app’s JavaScript runtime (debug.evaluate)debug.evaluate
logs:readRead logs and crash reportslogs.stream, logs.read, logs.crashes
runs:readRead and follow test runsruns.list, runs.get, runs.events
runs:reportPublish a test run’s reporter eventsruns.publish

public (no credential): runtime.version, pairings.redeem.

session (any authenticated principal): runtime.capabilities.

Trust-class (locally only the runtime owner token; in the cloud only an interactive user session re-authenticated within 15 minutes; never an API key or an MCP token): pairings.create.

esc

    Type to search every page, the protocol reference and the cloud API.