Troupeby AliveDocsSign in

Reference

system

Device settings: location, appearance, the clipboard and the status bar. Index · shared schemas · errors.

ProcedureSummaryRESTMCP toolStability
system.setLocationSet or clear a simulated locationPOST—experimental
system.setAppearanceSwitch light or dark modePOST—experimental
system.getClipboardRead the device clipboard as textGET—experimental
system.setClipboardWrite the device clipboardPOST—experimental
system.setStatusBarPin the status bar to fixed values for screenshots, or restore the live onePOST—experimental

system.setLocation

Set or clear a simulated location

RESTPOST /v1/system/set-location (input as a JSON body)
RPC/rpc/v2/system/setLocation
MCPnot a tool (low value or high risk for agents); hints: idempotent
Authdevices:drive
Tenancyproject
Requiressystem.location
Troupe Cloudrelayed through the host agent to the device host’s runtime
Stabilityexperimental, since 1.0

Input:

TypeScript
{
  sessionId: SessionId
  location: {
    latitude: number  // -90–90
    longitude: number  // -180–180
    altitude?: number
    accuracyM?: number  // ≥ 0
  } | null
}

Output:

TypeScript
{}

Errors: D.

Named types: SessionId.

system.setAppearance

Switch light or dark mode

RESTPOST /v1/system/set-appearance (input as a JSON body)
RPC/rpc/v2/system/setAppearance
MCPnot a tool (low value or high risk for agents); hints: idempotent
Authdevices:drive
Tenancyproject
Requiressystem.appearance
Troupe Cloudrelayed through the host agent to the device host’s runtime
Stabilityexperimental, since 1.0

Input:

TypeScript
{ sessionId: SessionId; appearance: Appearance }

Output:

TypeScript
{}

Errors: D.

Named types: Appearance, SessionId.

system.getClipboard

Read the device clipboard as text

RESTGET /v1/system/get-clipboard (input as query parameters)
RPC/rpc/v2/system/getClipboard
MCPnot a tool (low value or high risk for agents); hints: read-only, idempotent
Authdevices:drive
Tenancyproject
Requiressystem.clipboard
Troupe Cloudrelayed through the host agent to the device host’s runtime
Stabilityexperimental, since 1.0

Input:

TypeScript
{ sessionId: SessionId }

Output:

TypeScript
{ text: string }

Errors: D.

Named types: SessionId.

system.setClipboard

Write the device clipboard

RESTPOST /v1/system/set-clipboard (input as a JSON body)
RPC/rpc/v2/system/setClipboard
MCPnot a tool (low value or high risk for agents); hints: idempotent
Authdevices:drive
Tenancyproject
Requiressystem.clipboard
Troupe Cloudrelayed through the host agent to the device host’s runtime
Stabilityexperimental, since 1.0

Input:

TypeScript
{
  sessionId: SessionId
  text: string  // ≤ 65536 chars
}

Output:

TypeScript
{}

Errors: D.

Named types: SessionId.

system.setStatusBar

Pin the status bar to fixed values for screenshots, or restore the live one

RESTPOST /v1/system/set-status-bar (input as a JSON body)
RPC/rpc/v2/system/setStatusBar
MCPnot a tool (low value or high risk for agents); hints: idempotent
Authdevices:drive
Tenancyproject
Requiressystem.statusBar
Troupe Cloudrelayed through the host agent to the device host’s runtime
Stabilityexperimental, since 1.0

Input:

TypeScript
{ sessionId: SessionId; pinned: boolean }

Output:

TypeScript
{}

Errors: D.

Named types: SessionId.

esc

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