test_inbox_connection
Live-probes a connected inbox and, when asked, forces a credential refresh through the pinned OAuth route.
# MCP tool reference
1 callable tools.
Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference.
Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result.
[Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt)
## test_inbox_connection
Live-probes a connected inbox and, when asked, forces a credential refresh through the pinned OAuth route.
When asked whether an inbox still connects, or to heal a stale grant.
For pre-connect credential checks — those are human-only by design.
Scopes: inbox:read, inbox:update
Risk: read; confirmation: none; idempotency: supported.
### Input schema (personal API key)
```json
{
"type": "object",
"anyOf": [
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"test"
]
}
},
"required": [
"workspaceId",
"inboxId",
"action"
],
"patternProperties": {
"^(?!(?:workspaceId|inboxId|action)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"inboxId",
"action"
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"refresh"
]
}
},
"required": [
"workspaceId",
"inboxId",
"action"
],
"patternProperties": {
"^(?!(?:workspaceId|inboxId|action)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"workspaceId",
"inboxId",
"action"
]
}
}
]
}
```
### Input schema (OAuth / delegated agent)
```json
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"format": "uuid",
"description": "Target Workspace UUID. Call list_workspaces to enumerate the Workspaces this credential may access, then pass the chosen id here."
}
},
"required": [
"workspaceId"
],
"anyOf": [
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"test"
]
}
},
"required": [
"workspaceId",
"inboxId",
"action"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|inboxId|action)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"inboxId",
"action"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
},
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"action": {
"type": "string",
"enum": [
"refresh"
]
}
},
"required": [
"workspaceId",
"inboxId",
"action"
],
"patternProperties": {
"^(?!(?:workspaceId)$)[\\s\\S]*?(?:^(?!(?:workspaceId|inboxId|action)$)[\\s\\S]*$)": false
},
"additionalProperties": true,
"propertyNames": {
"anyOf": [
{
"type": "string",
"enum": [
"workspaceId",
"inboxId",
"action"
]
},
{
"enum": [
"workspaceId"
]
}
]
}
}
]
}
```
### Output schema (structuredContent)
```json
{
"$defs": {
"EmailAddress": {
"type": "string",
"minLength": 3,
"maxLength": 320,
"pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"
},
"ShortText": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"UtcDateTimeEncoded": {
"type": "string",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
},
"OpaqueId": {
"type": "string",
"minLength": 1,
"maxLength": 512
}
},
"type": "object",
"anyOf": [
{
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"email": {
"$ref": "#/$defs/EmailAddress"
},
"grantedScopes": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"tokenExpiresAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"error": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"ok"
],
"patternProperties": {
"^(?!(?:ok|email|grantedScopes|tokenExpiresAt|error)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"ok",
"email",
"grantedScopes",
"tokenExpiresAt",
"error"
]
}
},
{
"type": "object",
"properties": {
"connectionId": {
"$ref": "#/$defs/OpaqueId"
},
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"provider": {
"type": "string",
"enum": [
"google_workspace",
"microsoft_365",
"imap_smtp"
]
},
"emailAddress": {
"$ref": "#/$defs/EmailAddress"
},
"state": {
"type": "string",
"enum": [
"connected",
"needs_reauthorization",
"quarantined",
"alert",
"disconnected"
]
},
"grantedScopes": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"tokenExpiresAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"watchExpiresAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"credentialRefId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"lastSyncAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"connectionId",
"inboxId",
"provider",
"emailAddress",
"state",
"tokenExpiresAt",
"watchExpiresAt",
"credentialRefId",
"lastSyncAt"
],
"patternProperties": {
"^(?!(?:connectionId|inboxId|provider|emailAddress|state|grantedScopes|tokenExpiresAt|watchExpiresAt|credentialRefId|lastSyncAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"connectionId",
"inboxId",
"provider",
"emailAddress",
"state",
"grantedScopes",
"tokenExpiresAt",
"watchExpiresAt",
"credentialRefId",
"lastSyncAt"
]
}
}
]
},
{
"type": "object"
}
]
},
{
"type": "object",
"properties": {
"data": {
"allOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"ok": {
"type": "boolean"
},
"email": {
"$ref": "#/$defs/EmailAddress"
},
"grantedScopes": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"tokenExpiresAt": {
"$ref": "#/$defs/UtcDateTimeEncoded"
},
"error": {
"$ref": "#/$defs/ShortText"
}
},
"required": [
"ok"
],
"patternProperties": {
"^(?!(?:ok|email|grantedScopes|tokenExpiresAt|error)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"ok",
"email",
"grantedScopes",
"tokenExpiresAt",
"error"
]
}
},
{
"type": "object",
"properties": {
"connectionId": {
"$ref": "#/$defs/OpaqueId"
},
"inboxId": {
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
"provider": {
"type": "string",
"enum": [
"google_workspace",
"microsoft_365",
"imap_smtp"
]
},
"emailAddress": {
"$ref": "#/$defs/EmailAddress"
},
"state": {
"type": "string",
"enum": [
"connected",
"needs_reauthorization",
"quarantined",
"alert",
"disconnected"
]
},
"grantedScopes": {
"type": "array",
"items": {
"$ref": "#/$defs/ShortText"
}
},
"tokenExpiresAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"watchExpiresAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
},
"credentialRefId": {
"anyOf": [
{
"type": "string",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
"format": "uuid"
},
{
"type": "null"
}
]
},
"lastSyncAt": {
"anyOf": [
{
"$ref": "#/$defs/UtcDateTimeEncoded"
},
{
"type": "null"
}
]
}
},
"required": [
"connectionId",
"inboxId",
"provider",
"emailAddress",
"state",
"tokenExpiresAt",
"watchExpiresAt",
"credentialRefId",
"lastSyncAt"
],
"patternProperties": {
"^(?!(?:connectionId|inboxId|provider|emailAddress|state|grantedScopes|tokenExpiresAt|watchExpiresAt|credentialRefId|lastSyncAt)$)[\\s\\S]*$": false
},
"additionalProperties": true,
"propertyNames": {
"type": "string",
"enum": [
"connectionId",
"inboxId",
"provider",
"emailAddress",
"state",
"grantedScopes",
"tokenExpiresAt",
"watchExpiresAt",
"credentialRefId",
"lastSyncAt"
]
}
}
]
},
{
"not": {
"type": "object"
}
}
]
}
},
"required": [
"data"
],
"additionalProperties": false
}
]
}
```
### Underlying API operations
- `inboxConnections.test`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/test`
- `inboxConnections.refreshGrant`: `POST /v1/workspaces/:workspaceId/inboxes/:inboxId/refresh`
Scheduler Zero