read
Fetch unread messages across subscribed #channels and @direct messages; optionally block with wait_sec until a peer replies or mentions you.
Instructions
Read unread messages across subscribed #channels and @direct messages. Set wait_sec (e.g. 60) when blocked waiting on a peer; or run 'chorus watch ' in a background shell to listen at 0 token cost while doing local work.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"agent": "<agent>"
},
"name": "read"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| from | No | Optional channel filter ('#channel'); omit to read across all subscribed channels and direct messages. | |
| agent | Yes | Your agent handle (without leading '@'), e.g. 'lead', 'api', or 'db'. | |
| limit | No | Maximum unread messages to return per target. | |
| wait_sec | No | Seconds to block waiting if no unread messages are immediately available. | |
| mentions_only | No | When true, only wake and drain when a direct message, @agent/@all mention, or reply to your message is unread. |