Skip to main content
Glama

Get inbox

get_inbox
Read-onlyIdempotent

Get one inbox with its full settings (greeting, business hours, CSAT, auto-assignment) and the AI agent attached to it (agent_bot: id and name, null when none is).

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": {
      "inbox_id": "<inbox_id>"
    },
    "name": "get_inbox"
  }
}

Input Schema

NameRequiredDescriptionDefault
fieldsNoOptional: return only these fields of each record.
inbox_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / fields / items / enum
      Previous value: -[
      -  "id",
      -  "name",
      -  "channel_type",
      -  "greeting_enabled",
      -  "greeting_message",
      -  "working_hours_enabled",
      -  "csat_survey_enabled",
      -  "enable_auto_assignment",
      -  "out_of_office_message",
      -  "working_hours",
      -  "timezone",
      -  "allow_messages_after_resolved",
      -  "lock_to_single_conversation",
      -  "business_name",
      -  "help_center",
      -  "widget_color",
      -  "appearance",
      -  "agent_bot"
      -]New value: +[
      +  "id",
      +  "name",
      +  "channel_type",
      +  "greeting_enabled",
      +  "greeting_message",
      +  "working_hours_enabled",
      +  "csat_survey_enabled",
      +  "enable_auto_assignment",
      +  "out_of_office_message",
      +  "working_hours",
      +  "timezone",
      +  "allow_messages_after_resolved",
      +  "lock_to_single_conversation",
      +  "business_name",
      +  "help_center",
      +  "widget_color",
      +  "appearance",
      +  "allowed_domains",
      +  "csat_config",
      +  "agent_bot"
      +]
  2. First observed

TDQS

A3.6/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 fully covered. The description's added value is the return semantics — specifically that agent_bot carries id and name and is null when no bot is attached — but it says nothing about behavior for a missing/invalid inbox_id. Adequate, not rich.

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

Conciseness5/5

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

One front-loaded sentence with the resource stated first, the payload enumerated parenthetically, and the nullable agent_bot detail folded in at the end. No filler and nothing buried.

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?

With only two parameters, no output schema, and full annotation coverage, the description does most of the necessary work by sketching the returned object and the nullable agent_bot. It stops short of explaining the `fields` projection or the response envelope, which keeps it from being complete.

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?

Schema coverage is 50%: `fields` documents itself while `inbox_id` is self-evident. The description never mentions the `fields` projection parameter and instead says "full settings", which slightly undercuts the fact that callers can request a subset — a missed opportunity to explain the interaction.

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?

Specific verb and resource ("Get one inbox") with an explicit inventory of what comes back (greeting, business hours, CSAT, auto-assignment, agent_bot). This clearly separates it from list_inboxes by singular scope, though it never names get_inbox_agent_bot as the narrower alternative, which is the one sibling an agent could confuse it with.

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?

Usage is only implied by the singular framing and the enumeration of settings; there is no explicit statement of when to prefer this over list_inboxes or get_inbox_agent_bot/get_inbox_members. An agent can infer the intent, but the description does no routing work.

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