Reference
system
Device settings: location, appearance, the clipboard and the status bar. Index · shared schemas · errors.
| Procedure | Summary | REST | MCP tool | Stability |
|---|---|---|---|---|
system.setLocation | Set or clear a simulated location | POST | — | experimental |
system.setAppearance | Switch light or dark mode | POST | — | experimental |
system.getClipboard | Read the device clipboard as text | GET | — | experimental |
system.setClipboard | Write the device clipboard | POST | — | experimental |
system.setStatusBar | Pin the status bar to fixed values for screenshots, or restore the live one | POST | — | experimental |
system.setLocation
Set or clear a simulated location
| REST | POST /v1/system/set-location (input as a JSON body) |
| RPC | /rpc/v2/system/setLocation |
| MCP | not a tool (low value or high risk for agents); hints: idempotent |
| Auth | devices:drive |
| Tenancy | project |
| Requires | system.location |
| Troupe Cloud | relayed through the host agent to the device host’s runtime |
| Stability | experimental, since 1.0 |
Input:
{
sessionId: SessionId
location: {
latitude: number // -90–90
longitude: number // -180–180
altitude?: number
accuracyM?: number // ≥ 0
} | null
}Output:
{}Errors: D.
Named types: SessionId.
system.setAppearance
Switch light or dark mode
| REST | POST /v1/system/set-appearance (input as a JSON body) |
| RPC | /rpc/v2/system/setAppearance |
| MCP | not a tool (low value or high risk for agents); hints: idempotent |
| Auth | devices:drive |
| Tenancy | project |
| Requires | system.appearance |
| Troupe Cloud | relayed through the host agent to the device host’s runtime |
| Stability | experimental, since 1.0 |
Input:
{ sessionId: SessionId; appearance: Appearance }Output:
{}Errors: D.
Named types: Appearance, SessionId.
system.getClipboard
Read the device clipboard as text
| REST | GET /v1/system/get-clipboard (input as query parameters) |
| RPC | /rpc/v2/system/getClipboard |
| MCP | not a tool (low value or high risk for agents); hints: read-only, idempotent |
| Auth | devices:drive |
| Tenancy | project |
| Requires | system.clipboard |
| Troupe Cloud | relayed through the host agent to the device host’s runtime |
| Stability | experimental, since 1.0 |
Input:
{ sessionId: SessionId }Output:
{ text: string }Errors: D.
Named types: SessionId.
system.setClipboard
Write the device clipboard
| REST | POST /v1/system/set-clipboard (input as a JSON body) |
| RPC | /rpc/v2/system/setClipboard |
| MCP | not a tool (low value or high risk for agents); hints: idempotent |
| Auth | devices:drive |
| Tenancy | project |
| Requires | system.clipboard |
| Troupe Cloud | relayed through the host agent to the device host’s runtime |
| Stability | experimental, since 1.0 |
Input:
{
sessionId: SessionId
text: string // ≤ 65536 chars
}Output:
{}Errors: D.
Named types: SessionId.
system.setStatusBar
Pin the status bar to fixed values for screenshots, or restore the live one
| REST | POST /v1/system/set-status-bar (input as a JSON body) |
| RPC | /rpc/v2/system/setStatusBar |
| MCP | not a tool (low value or high risk for agents); hints: idempotent |
| Auth | devices:drive |
| Tenancy | project |
| Requires | system.statusBar |
| Troupe Cloud | relayed through the host agent to the device host’s runtime |
| Stability | experimental, since 1.0 |
Input:
{ sessionId: SessionId; pinned: boolean }Output:
{}Errors: D.
Named types: SessionId.