Skip to main content
Glama

list_clients

Read-onlyIdempotent

List online devices belonging to the token, with their identifiers and metadata. A positive wait_ms waits while no device is online; any online device completes the wait. An empty array means no device was online when the call returned. Waiting calls also include status and next_action.

Input Schema

NameRequiredDescriptionDefault
wait_msNoMaximum connection wait in milliseconds while no device is online. 0 returns a snapshot immediately.
client_tokenYesTarget client connection token, required with management access (including stdio and no-password mode). Device-scoped bearer access implicitly selects its own token.

Output Schema

NameRequiredDescriptionDefault
statusNoConnection wait status: waiting or connected.
clientsYesOnline devices owned by this token; an empty array means none are currently online.
next_actionNoNext step to perform. Invitation creation returns the exact tool call and deadline; other tools return human-readable guidance.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • changedInput schema / properties / client_token / description
      Previous value: -"Target client connection token (required when authenticated with the management key)"New value: +"Target client connection token, required with management access (including stdio and no-password mode). Device-scoped bearer access implicitly selects its own token."
    • changedInput schema / properties / wait_ms / description
      Previous value: -"Wait up to this many milliseconds while no device is online (0-20000, default 0). After creating an invitation, use 20000 and repeat empty results until connection, invitation expiry, or user cancellation."New value: +"Maximum connection wait in milliseconds while no device is online. 0 returns a snapshot immediately."
    • changedOutput schema / additionalProperties
      Previous value: -trueNew value: +false
    • addedOutput schema / properties
      Added value: +{
      +  "clients": {
      +    "description": "Online devices owned by this token; an empty array means none are currently online.",
      +    "items": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "client_id": {
      +          "description": "Six-character device identifier. Required to select a device for multi-device tokens.",
      +          "type": "string"
      +        },
      +        "client_info": {
      +          "additionalProperties": false,
      +          "description": "Device-reported environment metadata. Empty fields mean unknown or not reported.",
      +          "properties": {
      +            "arch": {
      +              "description": "Client process architecture, such as amd64 or arm64.",
      +              "type": "string"
      +            },
      +            "client_version": {
      +              "description": "Client application version reported during the connection handshake.",
      +              "type": "string"
      +            },
      +            "default_cwd": {
      +              "description": "Client working directory at connection time, inherited by commands when cwd is omitted.",
      +              "type": "string"
      +            },
      +            "hostname": {
      +              "description": "Device-reported hostname for display only, not authentication.",
      +              "type": "string"
      +            },
      +            "platform": {
      +              "description": "Device-reported operating system.",
      +              "type": "string"
      +            },
      +            "shell": {
      +              "description": "Device-reported command interpreter path used by execute_command and session_start. Empty means unknown or not reported.",
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "hostname",
      +            "platform",
      +            "arch",
      +            "shell",
      +            "default_cwd",
      +            "client_version"
      +          ],
      +          "type": "object"
      +        },
      +        "connected_at": {
      +          "description": "UTC connection time in RFC 3339 format.",
      +          "type": "string"
      +        },
      +        "status": {
      +          "description": "Device connection display status: Connected, with the latest server-client heartbeat RTT when measured, e.g. Connected · 203ms.",
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "status",
      +        "client_id",
      +        "client_info",
      +        "connected_at"
      +      ],
      +      "type": "object"
      +    },
      +    "type": [
      +      "null",
      +      "array"
      +    ]
      +  },
      +  "next_action": {
      +    "description": "Next step to perform. Invitation creation returns the exact tool call and deadline; other tools return human-readable guidance.",
      +    "type": "string"
      +  },
      +  "status": {
      +    "description": "Connection wait status: waiting or connected.",
      +    "type": "string"
      +  }
      +}
    • addedOutput schema / required
      Added value: +[
      +  "clients"
      +]
  2. First observed

TDQS

A4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint=false. The description adds meaningful behavior beyond annotations: positive wait_ms blocks until a device is online, an empty array means no device was online at return time, and waiting calls include status and next_action.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is compact and front-loaded: it starts with the core purpose, then adds wait semantics, empty-array meaning, and waiting-call fields. Every sentence provides useful information without repetition or fluff.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the output schema and annotations, the description covers the key behavioral details an agent needs: what is listed, how waiting works, what an empty result means, and what extra fields appear in waiting calls. Authentication and token semantics are already covered by the schema.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 100% schema description coverage, the baseline is 3. The description adds semantic detail for wait_ms by clarifying that a positive value waits while no device is online and that any online device completes the wait, going slightly beyond the schema's wording.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource: 'List online devices belonging to the token, with their identifiers and metadata.' This is clear, but it does not explicitly distinguish the tool from siblings such as create_client or the session tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explains the wait_ms behavior and the meaning of an empty array, implying when to use waiting vs snapshot mode. However, it does not explicitly say when to use this tool versus alternatives like create_client or session_start, so usage guidance is only implied.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources