Skip to main content
Glama

list_agent_inbox

Read-onlyIdempotent

Deprecated: use search_inbound_items. Still served unchanged during the alias window. List/search current assigned postal mail using the same /v1/agent-inbox service. q is literal AND search of IDs, stored metadata and authorized stored OCR (NFKC/lowercase, max 200 characters and 12 terms), before pagination; nonempty q additionally needs agent.read. When indexed-source reads are enabled for the account, indexed search includes saved exterior and requested-content pages, including later sample captures. Optional received_after (inclusive) and received_before (exclusive) require that rollout and both read scopes; they filter the stored intake timestamp, never a date guessed from a letter. Sender/address keywords use q and OCR evidence, not an invented sender field. Returns metadata, not text. No fuzzy search or new OCR. Sandbox sees isolated fixtures and enabled assigned member samples; Live sees approved assigned private mail. Read selected matches using get_agent_inbox_sources after indexed rollout, not the original sample /context. Follow pagination.next_offset only while <=10000; narrow query/date windows before exceeding the cap and report incomplete results. Required scopes: agent.inbox.read. Agent-scoped bearer key required; member/facility keys cannot impersonate an agent. Rollout switches, current member approval, assignment, credential environment and SQL authorization are shared with REST. Never substitute another key or mail API after denial.

Input Schema

NameRequiredDescriptionDefault
qNoLiteral AND search: every term (max 12, 200 characters, NFKC-normalized and lowercased) must appear in the reference, the sender line or the OCR text of a readable page. Not fuzzy; punctuation is literal.
limitNoPage size, 1–50 (default 25).
offsetNoItems to skip, 0–10000 (default 0). Advance by the number returned while more remain; results are a current view, not a snapshot.
received_afterNoInclusive intake time (ISO 8601 with offset): when the facility logged the item, never a printed date.
received_beforeNoExclusive intake time (ISO 8601 with offset); must be after received_after.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • addedInput schema / properties / limit / description
      Added value: +"Page size, 1–50 (default 25)."
    • addedInput schema / properties / offset / description
      Added value: +"Items to skip, 0–10000 (default 0). Advance by the number returned while more remain; results are a current view, not a snapshot."
    • addedInput schema / properties / q / description
      Added value: +"Literal AND search: every term (max 12, 200 characters, NFKC-normalized and lowercased) must appear in the reference, the sender line or the OCR text of a readable page. Not fuzzy; punctuation is literal."
    • addedInput schema / properties / received_after / description
      Added value: +"Inclusive intake time (ISO 8601 with offset): when the facility logged the item, never a printed date."
    • addedInput schema / properties / received_before / description
      Added value: +"Exclusive intake time (ISO 8601 with offset); must be after received_after."
  2. Changed3 schema fields changed
    • addedInput schema / properties / received_after
      Added value: +{
      +  "format": "date-time",
      +  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      +  "type": "string"
      +}
    • addedInput schema / properties / received_before
      Added value: +{
      +  "format": "date-time",
      +  "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      +  "type": "string"
      +}
    • addedOutput schema / properties / result / properties / filters
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "received_after": {
      +      "format": "date-time",
      +      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      +      "type": "string"
      +    },
      +    "received_before": {
      +      "format": "date-time",
      +      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
  3. Added

TDQS

A4.8/5.0
Behavior5/5

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

Annotations cover the read-only/idempotent safety profile, and the description adds substantial context beyond that: required scopes (agent.inbox.read, plus agent.read for nonempty q), the agent-scoped bearer-key constraint (member/facility keys cannot impersonate), the 10000 pagination cap with incomplete-results caveat, sandbox-vs-live data differences, and that no fuzzy search or new OCR occurs. This is rich behavioral disclosure that the annotations alone do not provide.

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

Conciseness4/5

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

The deprecation warning is front-loaded, which is the single most important fact. However, the body is a dense run-on of semicolon-linked clauses combining search semantics, rollout gating, credential rules, and pagination, so it is less scannable than it could be. Nearly every clause carries needed information, so little is wasted.

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

Completeness5/5

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

For a 5-param, 0-required read tool with an output schema present, the description covers everything an agent needs: deprecated status, routing to the replacement and to get_agent_inbox_sources for follow-up reads, auth/scope requirements, pagination limits, and the fact that results are metadata not text. No material gap remains.

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

Parameters4/5

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

Schema coverage is 100%, so baseline is 3, but the description adds real semantic detail: q is literal AND over IDs/metadata/authorized OCR with a 12-term cap and additionally needs agent.read; received_after is inclusive / received_before exclusive and require the rollout plus both read scopes; sender keywords go through q, not an invented field. It clarifies scoping and normalization beyond the schema.

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

Purpose5/5

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

States a specific verb+resource ('List/search current assigned postal mail') and immediately distinguishes itself from the sibling it is deprecated in favor of: 'Deprecated: use search_inbound_items.' The scope ('same /v1/agent-inbox service') and behavior ('returns metadata, not text') are explicit, so an agent can tell it apart from get_agent_inbox_sources or search_inbound_items without opening a schema.

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

Usage Guidelines5/5

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

Gives explicit when-to-use guidance ('Deprecated: use search_inbound_items. Still served unchanged during the alias window'), names an alternative for follow-up ('Read selected matches using get_agent_inbox_sources after indexed rollout, not the original sample /context'), and specifies the alternative explicitly. When/when-not and alternatives are all present.

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.