← All toolsCommunicationsignalAll editions

SIGNAL_READ

Read pending/received Signal messages.

Parameters

NameTypeRequiredDescription
timeoutinteger—Seconds to wait for new messages (default 1)

How to use it

You normally trigger this by describing what you want in chat — the agent selects SIGNAL_READ automatically. For example:

Try saying
“signal my signal”

In a workflow

As a step in a multi-step workflow DAG:

json
{
  "id": "s1",
  "agent": "signal",
  "action": "SIGNAL_READ",
  "args": {
    "timeout": 1
  },
  "depends_on": [],
  "outputs": []
}

Direct call

For scripting, call it directly via POST /execute_tool. Every tool returns { success, message, data }.

bash
curl -X POST http://127.0.0.1:8000/execute_tool \
  -H "Content-Type: application/json" \
  -d '{"tool_name":"SIGNAL_READ","args":{"timeout":1}}'

Part of the signal plugin. Browse the full Plugin & Tool Catalog or the relevant feature guide.