FleetDeckDocs

MCP / Tool reference

fleetdeck_devices

List dashboard phones assigned to this key, including assigned rental devices.

Required permissiondevices:read

Parameters

No parameters. Pass an empty object.

View JSON Schema
json
{
  "type": "object",
  "properties": {},
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Call example

MCP call · SDK
const result = await client.callTool({
  name: "fleetdeck_devices",
  arguments: {}
});
if (result.isError) {
  console.error(result.content);
} else {
  console.log(result.content);
}

The SDK example assumes an initialized MCP client. See connection setup for HTTP authentication, initialization and stdio configuration.

Response

The result contains content blocks and isError. The text block contains JSON with the fields below. See the corresponding REST response contract.

Illustrative tool result
{
  "content": [
    {
      "type": "text",
      "text": "{\n  \"devices\": [\n    {\n      \"id\": \"device_123\",\n      \"name\": \"Test phone\",\n      \"platform\": \"android\",\n      \"model\": null,\n      \"os\": null,\n      \"status\": \"online\",\n      \"lastSeenAt\": \"2030-01-01T10:00:00.000Z\",\n      \"relayRegion\": \"eu\",\n      \"agentWebrtc\": false,\n      \"wdaStatus\": \"idle\"\n    }\n  ]\n}"
    }
  ],
  "isError": false
}
devicesobject[]always present

Devices granted to the current key. An empty array is a valid result.

View child fields
idstringalways present

Unique identifier of this resource. Use the returned value in subsequent requests.

min 1 charactersmax 128 characters
Validation pattern^[A-Za-z0-9._:-]+$
namestringalways present

Name of the resource or operation. For commands with an enum, choose one of the listed values.

platformstringalways present

Phone platform reported by the device, such as ios or android.

modelstring | nullalways present

Device model reported by the phone, or null when unavailable.

osstring | nullalways present

Operating system version reported by the phone, or null when unavailable.

statusstringalways present

Current state. A completed action means the driver finished; verify the intended screen or app effect separately.

lastSeenAtstring | nullalways present

Most recent recorded device contact, or null when no contact is recorded.

date-time
relayRegionstringalways present

Relay region used for the phone connection.

agentWebrtcbooleanalways present

Whether the phone advertises agent WebRTC support. This does not guarantee a usable JPEG screenshot stream.

wdaStatusstringalways present

Reported WebDriverAgent availability. Check current capabilities before choosing a command.

Behavior

  • The MCP descriptor marks this tool read-only and idempotent.
  • FleetDeck handler errors return isError=true with a JSON text payload. SDK input validation may return plain-text error content, and authentication or transport can fail before a tool result exists. Screenshot results place image content in MCP image blocks and omit those bytes from the parallel JSON block.

Errors

401UNAUTHORIZEDMissing, malformed, expired or revoked credential; user verification/password state can also deny access.

Recovery: Use Authorization: Bearer with a valid scoped key. For dashboard routes, sign in. Job children require an active parent job and timely renewal.

Full error reference ↗
403FORBIDDENRequired scope, device grant, account membership or worker identity is missing.

Recovery: Check the endpoint’s scopes, exact device, owning key and workerId. A different key cannot access the original key’s sessions or jobs.

Full error reference ↗
Client onlyCONNECTION_FAILEDThe client could not reach the configured FleetDeck origin.

Recovery: Check DNS, TLS, proxy/firewall and FLEETDECK_BASE_URL. Before replaying a mutation, query its saved requestId when connectivity returns.

Full error reference ↗
Client onlyINVALID_RESPONSEThe server response was not valid FleetDeck JSON.

Recovery: Check that the base URL points to FleetDeck and that a proxy did not replace the response. Preserve the original action identifiers before retrying.

Full error reference ↗
500INTERNALUnexpected service error.

Recovery: Save nonsecret request context and time for support. Query action status before repeating a mutation; never assume it did not execute.

Full error reference ↗

SDK validation can return plain-text error content. Authentication and transport may fail before a tool result exists. Read the JSON-RPC and transport error reference before parsing the text as JSON.

Annotations

AnnotationValue
readOnlyHinttrue
destructiveHintfalse
idempotentHinttrue
openWorldHinttrue