Skip to main content
List agent workers connected to a project

Tool details

FieldValue
Namelist_agent_workers
GroupAgents

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "minLength": 1,
      "description": "Project identifier or slug that scopes the tool call."
    }
  },
  "required": [
    "project_reference"
  ],
  "additionalProperties": false,
  "description": "Input schema for the list_agent_workers tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "description": "Unique identifier for the returned record."
          },
          "project_id": {
            "type": "string",
            "format": "uuid",
            "description": "Project identifier associated with this result."
          },
          "implementation_kind": {
            "type": "string",
            "minLength": 1,
            "maxLength": 64,
            "pattern": "^[a-zA-Z0-9_-]+$",
            "description": "The implementation kind associated with this tool result."
          },
          "worker_key": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "pattern": "^[a-zA-Z0-9_.:-]+$",
            "description": "The worker key associated with this tool result."
          },
          "display_name": {
            "type": [
              "string",
              "null"
            ],
            "description": "The display name associated with this tool result."
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "disabled"
            ],
            "description": "Lifecycle status for the returned record."
          },
          "connection_status": {
            "type": "string",
            "enum": [
              "online",
              "offline",
              "disabled"
            ],
            "description": "The connection status associated with this tool result."
          },
          "metadata": {
            "anyOf": [
              {
                "description": "Additional structured metadata returned by the tool."
              },
              {
                "type": "null",
                "description": "Additional structured metadata returned by the tool."
              }
            ],
            "description": "Additional structured metadata returned by the tool."
          },
          "last_heartbeat_at": {
            "type": [
              "string",
              "null"
            ],
            "description": "The last heartbeat at associated with this tool result."
          },
          "created_at": {
            "type": "string",
            "description": "Creation timestamp in ISO 8601 format."
          },
          "updated_at": {
            "type": "string",
            "description": "Last update timestamp in ISO 8601 format."
          }
        },
        "required": [
          "id",
          "project_id",
          "implementation_kind",
          "worker_key",
          "display_name",
          "status",
          "connection_status",
          "last_heartbeat_at",
          "created_at",
          "updated_at"
        ],
        "additionalProperties": false,
        "description": "One data item associated with this tool result."
      },
      "description": "Primary result records returned by the tool."
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the list_agent_workers tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}