Skip to main content
Glama

Get Mailbox settings

get_mailbox
Read-only

GET ONLY the 'Mailbox' field of TitlePublicConfigurationModel. Mailbox - an in-game mailbox that holds VALUE the player claims (not notifications - those are Push). Enabled is the master switch, default OFF. Capacity (default 100) caps visible letters; on overflow the oldest letters WITHOUT unclaimed rewards are removed. RewardLetterDays (30) / PlainLetterDays (14) are letter lifetimes (an unclaimed reward is lost when it expires), ClaimedRetentionDays (7) keeps claimed letters visible. DefaultLanguage (en) is the text fallback. Templates maps a TemplateID to per-language Texts {Subject, Body with {Param} placeholders}, Category (System/Reward/Gift/Social tab), Icon, Banner, Link {FeatureID+Args to open a game screen, or an https Url}, SenderName, ExpirationDays; keys 'system.*' override built-in letters of modules (system.gift, system.transfer, system.transfer_return, system.leaderboard_reward, system.coop_grand_prize, system.coop_object_reward, system.season_unclaimed, system.referral_reward). Gifts.Social maps a GiftID to a friend gift (Grant of items/virtual currencies minted on claim; optional Cost the sender pays per friend, burned; one per friend per period; the period is IntervalSeconds (default 86400) counted from AnchorUtc (default 2026-01-01 00:00 UTC) like fixed-interval cycles of other systems; SendLimit/ReceiveLimit per period, default 20; SenderGate). Gifts.Transfer lets friends send their OWN resources: AllowedResources whitelist (VirtualCurrency or STACKABLE items; MaxAmountPerGift is a CAP - any amount from 1 up to it, entries separately or together), MaxEntriesPerGift (5), IntervalSeconds/AnchorUtc (same period model), SendLimit/ReceiveLimit per period (5), FeePercent (0-90, withheld from what the friend receives, the fee per entry rounds up) and FeeCost (fixed fee on top); both burn only when the friend claims - a declined or expired transfer returns everything charged, MinFriendshipHours (24, against alt-account funnelling), ExpirationDays (7, then returned to the sender). Integrations {Leaderboard, CoopEvent, Season, Referral} (empty = on) bring unclaimed rewards of those modules to the mailbox. Letters and broadcasts themselves are NOT config: they are sent from the dashboard (player letters, segment broadcasts with a SegmentGate and a schedule) or by CloudCode server.SendMail; letters with rewards require the player-admin plan right.

Input Schema

NameRequiredDescriptionDefault
title_idYesTitleID, для которого читаются данные.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, but the description adds extensive behavioral context: default capacity, overflow removal of oldest letters without unclaimed rewards, expiration loss of unclaimed rewards, gift/transfer burn-on-claim mechanics, fee behavior, and the player-admin plan requirement for reward letters.

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?

Front-loads the core purpose, but then crams an extremely dense, unstructured block of model details into a single paragraph. The length is partly justified by the absence of an output schema, yet it is not scannable and could be structured more effectively.

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?

With no output schema, the description carries the full burden of explaining the returned Mailbox configuration, and it does so comprehensively. An agent has enough context to understand the resource and call the tool correctly.

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 description coverage is 100%, and the only parameter title_id is documented in the schema. The description adds no parameter-level meaning beyond what the schema provides, so the baseline 3 applies.

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 (GET) and resource (the 'Mailbox' field of TitlePublicConfigurationModel), and explicitly excludes notifications, which are handled by Push. An agent can distinguish it from get_push and save_mailbox without opening the 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?

Explicitly says notifications are not here but Push, and that letters/broadcasts are not config but sent via dashboard or CloudCode server.SendMail. This names alternatives and exclusions, clearly routing the agent to the right tool or mechanism.

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.