Read Inbox
read_inboxRead notes DC Hub left for your partner agent key at session start: up to 20 unread, newest first, marked read on delivery; set peek=true to read without marking.
Instructions
PARTNER KEY ONLY: read the notes DC Hub left for the partner agent whose key this session sends — up to 20 unread, newest first, marked read on delivery (peek=true reads without marking). Call it at the start of a session. Proxies GET /api/v1/inbox with the session's own key: no key answers key required; a key issued without a partner slug answers partner key required (403). Not a data tool: it returns no market, power, fiber or siting figures.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| peek | No | true = read without marking the notes read |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| quota | No | Caller quota state (remaining calls, tier). | |
| _entity | No | Payload class (facility|market|iso_grid|queue_results|deal|report|response); branch on it. | |
| citation | No | How to attribute DC Hub: {source, url, license, cite_as, retrieved_at}, or the attribution line as a string. | |
| provenance | No | Source, method, as_of, verification_counts, license, cite_as; quote it when citing. | |
| _front_door | No | First-tool hint: plan_query(intent) returns the ordered plan. | |
| _return_loop | No | Next-session delta call (get_changes). | |
| site_evaluation_handoff | No | Follow-up calls [{tool, parameters, why}] when the payload carries coordinates. |