Skip to main content
Glama

Get inbox status

getInboxStatus
Read-onlyIdempotent

Check whether inbound email is ready. Domains are added and verified with the domain management tools at /mcp/full. Result: ready, receiving_ready, processing_ready, summary, next_actions, domains, endpoints, functions and recent_emails.

Input Schema

NameRequiredDescriptionDefault
api_keyNoAPI key from createEmailAddress, used in place of sign-in.

Output Schema

NameRequiredDescriptionDefault
readyYesTrue when mail is received and processed.
domainsYesDomains that receive mail.
summaryYesPlain-language status, to tell the user.
endpointsYesWebhook endpoints, by state.
functionsYesFunctions, by deploy state.
next_actionsYesSteps left, most important first; empty when ready.
recent_emailsYesInbound activity.
receiving_readyYesTrue when some domain receives mail.
processing_readyYesTrue when received mail reaches a webhook or Function.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedOutput schema / properties / domains / items / properties / status / description
      Previous value: -"ready, stored_only, pending_dns or inactive."New value: +"Whether it receives and processes mail."
    • addedOutput schema / properties / domains / items / properties / status / enum
      Added value: +[
      +  "ready",
      +  "stored_only",
      +  "pending_dns",
      +  "inactive"
      +]
  2. Changed2 schema fields changed
    • changedOutput schema / properties / domains / items / properties / status / description
      Previous value: -"Whether it receives and processes mail."New value: +"ready, stored_only, pending_dns or inactive."
    • removedOutput schema / properties / domains / items / properties / status / enum
      Removed value: -[
      -  "ready",
      -  "stored_only",
      -  "pending_dns",
      -  "inactive"
      -]
  3. Changed2 schema fields changed
    • changedOutput schema / properties / domains / items / properties / status / description
      Previous value: -"ready, stored_only, pending_dns or inactive."New value: +"Whether it receives and processes mail."
    • addedOutput schema / properties / domains / items / properties / status / enum
      Added value: +[
      +  "ready",
      +  "stored_only",
      +  "pending_dns",
      +  "inactive"
      +]
  4. Changed15 schema fields changed
    • addedOutput schema / additionalProperties
      Added value: +false
    • changedOutput schema / description
      Previous value: -"Envelope; the result is in data.data."New value: +"Whether inbound mail is set up, and what is left to do."
    • removedOutput schema / properties / data
      Removed value: -{
      -  "description": "API response: the result in data, or error.",
      -  "properties": {
      -    "data": {
      -      "description": "Whether inbound mail is set up.",
      -      "properties": {
      -        "domains": {
      -          "description": "Domains that receive mail.",
      -          "items": {
      -            "properties": {
      -              "domain": {
      -                "type": "string"
      -              },
      -              "email_count": {
      -                "type": [
      -                  "number",
      -                  "string"
      -                ]
      -              },
      -              "id": {
      -                "description": "Domain id, for domain_id filters.",
      -                "type": "string"
      -              },
      -              "latest_email_received_at": {
      -                "type": [
      -                  "string",
      -                  "null"
      -                ]
      -              },
      -              "processing_ready": {
      -                "type": "boolean"
      -              },
      -              "receiving_ready": {
      -                "type": "boolean"
      -              },
      -              "status": {
      -                "description": "ready, stored_only, pending_dns or inactive.",
      -                "type": "string"
      -              }
      -            },
      -            "type": "object"
      -          },
      -          "type": "array"
      -        },
      -        "endpoints": {
      -          "description": "Webhook endpoints.",
      -          "properties": {
      -            "disabled": {
      -              "type": [
      -                "number",
      -                "string"
      -              ]
      -            },
      -            "enabled": {
      -              "type": [
      -                "number",
      -                "string"
      -              ]
      -            },
      -            "total": {
      -              "type": [
      -                "number",
      -                "string"
      -              ]
      -            }
      -          },
      -          "type": "object"
      -        },
      -        "functions": {
      -          "description": "Deployed Functions.",
      -          "properties": {
      -            "deployed": {
      -              "type": [
      -                "number",
      -                "string"
      -              ]
      -            },
      -            "failed": {
      -              "type": [
      -                "number",
      -                "string"
      -              ]
      -            },
      -            "pending": {
      -              "type": [
      -                "number",
      -                "string"
      -              ]
      -            },
      -            "total": {
      -              "type": [
      -                "number",
      -                "string"
      -              ]
      -            }
      -          },
      -          "type": "object"
      -        },
      -        "next_actions": {
      -          "description": "Steps left: kind, message, command.",
      -          "type": "array"
      -        },
      -        "processing_ready": {
      -          "description": "Mail is routed somewhere.",
      -          "type": "boolean"
      -        },
      -        "ready": {
      -          "description": "Mail is received and processed.",
      -          "type": "boolean"
      -        },
      -        "receiving_ready": {
      -          "description": "A domain receives mail.",
      -          "type": "boolean"
      -        },
      -        "recent_emails": {
      -          "description": "Inbound activity.",
      -          "properties": {
      -            "latest_received_at": {
      -              "type": [
      -                "string",
      -                "null"
      -              ]
      -            },
      -            "total": {
      -              "type": [
      -                "number",
      -                "string"
      -              ]
      -            }
      -          },
      -          "type": "object"
      -        },
      -        "summary": {
      -          "description": "Plain-language status.",
      -          "type": "string"
      -        }
      -      },
      -      "type": [
      -        "object",
      -        "null"
      -      ]
      -    },
      -    "error": {
      -      "description": "Why the call was refused; absent on success.",
      -      "properties": {
      -        "code": {
      -          "description": "Error code to branch on.",
      -          "type": "string"
      -        },
      -        "message": {
      -          "description": "What went wrong, in words.",
      -          "type": "string"
      -        }
      -      },
      -      "type": [
      -        "object",
      -        "null"
      -      ]
      -    },
      -    "success": {
      -      "description": "True when data holds the result.",
      -      "type": "boolean"
      -    }
      -  },
      -  "type": "object"
      -}
    • addedOutput schema / properties / domains
      Added value: +{
      +  "description": "Domains that receive mail.",
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "domain": {
      +        "description": "Domain name.",
      +        "type": "string"
      +      },
      +      "email_count": {
      +        "description": "Emails received on it.",
      +        "type": "integer"
      +      },
      +      "id": {
      +        "description": "Domain id, for domain_id filters.",
      +        "type": "string"
      +      },
      +      "latest_email_received_at": {
      +        "description": "Last arrival; null if none.",
      +        "type": [
      +          "string",
      +          "null"
      +        ]
      +      },
      +      "processing_ready": {
      +        "description": "True when its mail reaches a webhook or Function.",
      +        "type": "boolean"
      +      },
      +      "receiving_ready": {
      +        "description": "True when it receives mail.",
      +        "type": "boolean"
      +      },
      +      "status": {
      +        "description": "ready, stored_only, pending_dns or inactive.",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "id",
      +      "domain",
      +      "status",
      +      "receiving_ready",
      +      "processing_ready",
      +      "email_count",
      +      "latest_email_received_at"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / endpoints
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Webhook endpoints, by state.",
      +  "properties": {
      +    "disabled": {
      +      "description": "Endpoints turned off.",
      +      "type": "integer"
      +    },
      +    "enabled": {
      +      "description": "Endpoints receiving mail.",
      +      "type": "integer"
      +    },
      +    "total": {
      +      "description": "All endpoints.",
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "total",
      +    "enabled",
      +    "disabled"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / functions
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Functions, by deploy state.",
      +  "properties": {
      +    "deployed": {
      +      "description": "Running.",
      +      "type": "integer"
      +    },
      +    "failed": {
      +      "description": "Failed to deploy.",
      +      "type": "integer"
      +    },
      +    "pending": {
      +      "description": "Still deploying.",
      +      "type": "integer"
      +    },
      +    "total": {
      +      "description": "All Functions.",
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "total",
      +    "deployed",
      +    "pending",
      +    "failed"
      +  ],
      +  "type": "object"
      +}
    • addedOutput schema / properties / next_actions
      Added value: +{
      +  "description": "Steps left, most important first; empty when ready.",
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "command": {
      +        "description": "CLI command that does it; absent when there is none.",
      +        "type": "string"
      +      },
      +      "kind": {
      +        "description": "The step, such as add_domain or verify_domain.",
      +        "type": "string"
      +      },
      +      "message": {
      +        "description": "What to do, in words.",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "kind",
      +      "message"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / processing_ready
      Added value: +{
      +  "description": "True when received mail reaches a webhook or Function.",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / ready
      Added value: +{
      +  "description": "True when mail is received and processed.",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / receiving_ready
      Added value: +{
      +  "description": "True when some domain receives mail.",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / recent_emails
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Inbound activity.",
      +  "properties": {
      +    "latest_received_at": {
      +      "description": "Last arrival; null if none.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "total": {
      +      "description": "Inbound emails stored.",
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "total",
      +    "latest_received_at"
      +  ],
      +  "type": "object"
      +}
    • removedOutput schema / properties / status
      Removed value: -{
      -  "description": "HTTP status; 2xx on success.",
      -  "type": "number"
      -}
    • addedOutput schema / properties / summary
      Added value: +{
      +  "description": "Plain-language status, to tell the user.",
      +  "type": "string"
      +}
    • removedOutput schema / properties / tool
      Removed value: -{
      -  "description": "Tool that answered.",
      -  "type": "string"
      -}
    • changedOutput schema / required
      Previous value: -[
      -  "tool",
      -  "status",
      -  "data"
      -]New value: +[
      +  "ready",
      +  "receiving_ready",
      +  "processing_ready",
      +  "summary",
      +  "next_actions",
      +  "domains",
      +  "endpoints",
      +  "functions",
      +  "recent_emails"
      +]
  5. Changed9 schema fields changed
    • changedInput schema / properties / api_key / description
      Previous value: -"Your API key from createEmailAddress, used in place of sign-in."New value: +"API key from createEmailAddress, used in place of sign-in."
    • changedOutput schema / properties / data / description
      Previous value: -"API response; result in data."New value: +"API response: the result in data, or error."
    • changedOutput schema / properties / data / properties / error / description
      Previous value: -"Refusal: code, message."New value: +"Why the call was refused; absent on success."
    • addedOutput schema / properties / data / properties / error / properties
      Added value: +{
      +  "code": {
      +    "description": "Error code to branch on.",
      +    "type": "string"
      +  },
      +  "message": {
      +    "description": "What went wrong, in words.",
      +    "type": "string"
      +  }
      +}
    • addedOutput schema / properties / data / properties / error / type
      Added value: +[
      +  "object",
      +  "null"
      +]
    • changedOutput schema / properties / data / properties / success / description
      Previous value: -"Accepted."New value: +"True when data holds the result."
    • changedOutput schema / properties / data / type
      Previous value: -[
      -  "object",
      -  "string",
      -  "null"
      -]New value: +"object"
    • changedOutput schema / properties / status / description
      Previous value: -"HTTP status."New value: +"HTTP status; 2xx on success."
    • addedOutput schema / properties / tool / description
      Added value: +"Tool that answered."
  6. Changed4 schema fields changed
    • changedOutput schema / description
      Previous value: -"Whether inbound mail is set up."New value: +"Envelope; the result is in data.data."
    • changedOutput schema / properties / data / description
      Previous value: -"API body."New value: +"API response; result in data."
    • addedOutput schema / properties / data / properties / data / description
      Added value: +"Whether inbound mail is set up."
    • changedOutput schema / properties / data / properties / error / description
      Previous value: -"Why refused."New value: +"Refusal: code, message."
  7. Changed9 schema fields changed
    • changedInput schema / properties / api_key / description
      Previous value: -"Key createEmailAddress returned. Send it when no account is signed in."New value: +"Your API key from createEmailAddress, used in place of sign-in."
    • changedOutput schema / properties / data / properties / data / properties / domains / description
      Previous value: -"Inbound domains: id, domain, status, email_count."New value: +"Domains that receive mail."
    • addedOutput schema / properties / data / properties / data / properties / domains / items
      Added value: +{
      +  "properties": {
      +    "domain": {
      +      "type": "string"
      +    },
      +    "email_count": {
      +      "type": [
      +        "number",
      +        "string"
      +      ]
      +    },
      +    "id": {
      +      "description": "Domain id, for domain_id filters.",
      +      "type": "string"
      +    },
      +    "latest_email_received_at": {
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "processing_ready": {
      +      "type": "boolean"
      +    },
      +    "receiving_ready": {
      +      "type": "boolean"
      +    },
      +    "status": {
      +      "description": "ready, stored_only, pending_dns or inactive.",
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
    • changedOutput schema / properties / data / properties / data / properties / endpoints / description
      Previous value: -"Webhook endpoint counts: total, enabled."New value: +"Webhook endpoints."
    • addedOutput schema / properties / data / properties / data / properties / endpoints / properties
      Added value: +{
      +  "disabled": {
      +    "type": [
      +      "number",
      +      "string"
      +    ]
      +  },
      +  "enabled": {
      +    "type": [
      +      "number",
      +      "string"
      +    ]
      +  },
      +  "total": {
      +    "type": [
      +      "number",
      +      "string"
      +    ]
      +  }
      +}
    • changedOutput schema / properties / data / properties / data / properties / functions / description
      Previous value: -"Function counts: total, deployed, failed."New value: +"Deployed Functions."
    • addedOutput schema / properties / data / properties / data / properties / functions / properties
      Added value: +{
      +  "deployed": {
      +    "type": [
      +      "number",
      +      "string"
      +    ]
      +  },
      +  "failed": {
      +    "type": [
      +      "number",
      +      "string"
      +    ]
      +  },
      +  "pending": {
      +    "type": [
      +      "number",
      +      "string"
      +    ]
      +  },
      +  "total": {
      +    "type": [
      +      "number",
      +      "string"
      +    ]
      +  }
      +}
    • changedOutput schema / properties / data / properties / data / properties / recent_emails / description
      Previous value: -"total, latest_received_at."New value: +"Inbound activity."
    • addedOutput schema / properties / data / properties / data / properties / recent_emails / properties
      Added value: +{
      +  "latest_received_at": {
      +    "type": [
      +      "string",
      +      "null"
      +    ]
      +  },
      +  "total": {
      +    "type": [
      +      "number",
      +      "string"
      +    ]
      +  }
      +}
  8. Changed6 schema fields changed
    • changedInput schema / properties / api_key / description
      Previous value: -"The api_key from createEmailAddress, for a connection with no signed-in account. Leave it out when signed in."New value: +"Key createEmailAddress returned. Send it when no account is signed in."
    • changedOutput schema / properties / data / properties / data / properties / domains / description
      Previous value: -"Inbound domains."New value: +"Inbound domains: id, domain, status, email_count."
    • changedOutput schema / properties / data / properties / data / properties / endpoints / description
      Previous value: -"Webhook counts."New value: +"Webhook endpoint counts: total, enabled."
    • changedOutput schema / properties / data / properties / data / properties / functions / description
      Previous value: -"Function counts."New value: +"Function counts: total, deployed, failed."
    • changedOutput schema / properties / data / properties / data / properties / next_actions / description
      Previous value: -"Steps left."New value: +"Steps left: kind, message, command."
    • changedOutput schema / properties / data / properties / data / properties / recent_emails / description
      Previous value: -"Recent arrivals."New value: +"total, latest_received_at."
  9. Changed14 schema fields changed
    • changedInput schema / properties / api_key / description
      Previous value: -"Only when no account is signed in: the api_key createEmailAddress returned, passed as is on every later call. Omit it when the user is signed in."New value: +"The api_key from createEmailAddress, for a connection with no signed-in account. Leave it out when signed in."
    • addedOutput schema / description
      Added value: +"Whether inbound mail is set up."
    • addedOutput schema / properties / data / description
      Added value: +"API body."
    • addedOutput schema / properties / data / properties / data / properties / domains / description
      Added value: +"Inbound domains."
    • addedOutput schema / properties / data / properties / data / properties / endpoints / description
      Added value: +"Webhook counts."
    • addedOutput schema / properties / data / properties / data / properties / functions / description
      Added value: +"Function counts."
    • changedOutput schema / properties / data / properties / data / properties / next_actions / description
      Previous value: -"Steps left to finish setup."New value: +"Steps left."
    • addedOutput schema / properties / data / properties / data / properties / processing_ready / description
      Added value: +"Mail is routed somewhere."
    • addedOutput schema / properties / data / properties / data / properties / receiving_ready / description
      Added value: +"A domain receives mail."
    • addedOutput schema / properties / data / properties / data / properties / recent_emails / description
      Added value: +"Recent arrivals."
    • addedOutput schema / properties / data / properties / data / properties / summary / description
      Added value: +"Plain-language status."
    • addedOutput schema / properties / data / properties / error / description
      Added value: +"Why refused."
    • addedOutput schema / properties / data / properties / success / description
      Added value: +"Accepted."
    • addedOutput schema / properties / status / description
      Added value: +"HTTP status."
  10. Changed3 schema fields changed
    • changedInput schema / properties / api_key / description
      Previous value: -"Primitive API key (prim_...). Only needed when this connection has no signed-in account: pass the api_key returned by createEmailAddress, unchanged, on every call for the rest of the conversation. Omit it when the user is signed in."New value: +"Only when no account is signed in: the api_key createEmailAddress returned, passed as is on every later call. Omit it when the user is signed in."
    • addedOutput schema / properties / data / properties / data / properties / next_actions / description
      Added value: +"Steps left to finish setup."
    • addedOutput schema / properties / data / properties / data / properties / ready / description
      Added value: +"Mail is received and processed."
  11. Changed4 schema fields changed
    • removedOutput schema / additionalProperties
      Removed value: -false
    • addedOutput schema / properties / data / properties
      Added value: +{
      +  "data": {
      +    "properties": {
      +      "domains": {
      +        "type": "array"
      +      },
      +      "endpoints": {
      +        "type": "object"
      +      },
      +      "functions": {
      +        "type": "object"
      +      },
      +      "next_actions": {
      +        "type": "array"
      +      },
      +      "processing_ready": {
      +        "type": "boolean"
      +      },
      +      "ready": {
      +        "type": "boolean"
      +      },
      +      "receiving_ready": {
      +        "type": "boolean"
      +      },
      +      "recent_emails": {
      +        "type": "object"
      +      },
      +      "summary": {
      +        "type": "string"
      +      }
      +    },
      +    "type": [
      +      "object",
      +      "null"
      +    ]
      +  },
      +  "error": {},
      +  "success": {
      +    "type": "boolean"
      +  }
      +}
    • addedOutput schema / properties / data / type
      Added value: +[
      +  "object",
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / statusText
      Removed value: -{
      -  "type": "string"
      -}
  12. Changed1 schema field changed
    • addedInput schema / properties / api_key
      Added value: +{
      +  "description": "Primitive API key (prim_...). Only needed when this connection has no signed-in account: pass the api_key returned by createEmailAddress, unchanged, on every call for the rest of the conversation. Omit it when the user is signed in.",
      +  "maxLength": 200,
      +  "minLength": 8,
      +  "type": "string"
      +}
  13. First observed

TDQS

B3.4/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint, idempotentHint, non-destructive, and closed-world, so the safety profile is covered. The description contributes the domain-verification dependency, which is real behavioral context, but says nothing about auth requirements, caching, or refresh timing for a status endpoint.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The first sentence is front-loaded and efficient, but the second half is a flat enumeration of return keys (ready, receiving_ready, processing_ready, summary, next_actions, domains, endpoints, functions, recent_emails) that duplicates the output schema rather than adding meaning.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a zero-required-parameter status check with annotations and an output schema, the description covers the essential purpose and the cross-tool dependency. The return-value enumeration is redundant given the output schema, but nothing critical an agent needs in order to call it is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

There is one optional parameter with 100% schema description coverage; the schema already explains that api_key comes from createEmailAddress and substitutes for sign-in. The description adds no further meaning about the parameter, which is acceptable at full coverage but earns only the baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The first sentence states a specific verb and resource ('Check whether inbound email is ready'), and the word 'inbound' implicitly separates it from the sibling getOutboundStatus. It stops short of naming that sibling explicitly, so the differentiation is inferential rather than stated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description adds a useful setup prerequisite: domains must be added and verified through the domain management tools at /mcp/full before this check is meaningful. However, it never states when an agent should call this versus getOutboundStatus, listEmails, or getAccount, leaving usage to inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources