← All toolsCommunicationimessagemacOS only

IMESSAGE_READ

Read recent messages across all conversations.

macOS only
This capability uses native Apple apps and is available in the macOS edition. The Linux editions offer equivalent cross-platform capabilities instead.

Parameters

NameTypeRequiredDescription
countintegerNumber of messages (default 20, max 100)
offsetintegerPagination offset (default 0)

How to use it

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

Try saying
“imessage my imessage”

In a workflow

As a step in a multi-step workflow DAG:

json
{
  "id": "s1",
  "agent": "imessage",
  "action": "IMESSAGE_READ",
  "args": {
    "count": 5,
    "offset": 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":"IMESSAGE_READ","args":{"count":5,"offset":1}}'

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