MCP Tool

`inboxes_read`

Read inboxes — durable work queues for agents — and their pending events. With no `id`, lists your inboxes. With `id`, returns that inbox (including its pending event count; expired events are never counted or returned). With `id` + `event_id`, returns that single pending event. With `id` + `include_events: true`, returns the inbox plus a page of its pending events (honors `limit`/`after`). Consumers should list events, process them, then call `inboxes_write` action=ack_event on each one to remove it from the queue.

Input schema

api_keystring

Optional API key for authentication.

idstring

Inbox ID (e.g. inbox_...). Omit to list inboxes.

event_idstring

Event ID (e.g. inbevt_...) to fetch a single pending event from the inbox.

include_eventsboolean

When fetching an inbox, also return a page of its pending events.

limitinteger

List size (1–100, default 20) for inbox lists and event pages.

afterstring

List cursor: ID of the last item from the previous page.

Example call

tools/call params

{
  "name": "inboxes_read",
  "arguments": {
    "api_key": "agt_…"
  }
}