Start connecting an inbox
add_inboxRegisters an inbox (pending credentials). Returns inboxId for follow-up tools plus sayToHuman. Show only sayToHuman to the human, then quietly call the matching start_* tool. Use propose_connection first if unsure of the provider. If your app refuses to run this tool, tell the person they can add the inbox themselves on the Inboxes page of the website, and point them to /docs/troubleshooting/agent-not-allowed.
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": {
"label": "<label>",
"provider": "<provider>",
"email": "<email>"
},
"name": "add_inbox"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| Yes | |||
| label | Yes | ||
| imapHost | No | For provider=imap: the IMAP server (e.g. mail.example.com). Filled in for Yahoo, AOL, Fastmail and Zoho addresses; required for any other domain. | |
| imapPort | No | IMAP port, default 993 | |
| imapUser | No | IMAP username if different from email. For provider=icloud with your own domain on iCloud+: the iCloud Mail address (ending in icloud.com, me.com or mac.com). | |
| provider | Yes |