Skip to main content
Glama

Sync Chat Channel

horizon_sync_chat_channel
Read-onlyIdempotent

Reads an authorized incremental chat channel snapshot after a subscription resync or explicit user action, returning visible message IDs and messages for the exact cached epoch.

Instructions

Reads an authorized incremental snapshot after subscription resync/event or explicit user action. Use when: explicit hosted chat actions after reading horizon://docs/chat. Not for: automatic sends, repeated polling, rich-text rendering or exposing moderation credentials. Use horizon_get_chat_operation to reconcile original sends, then horizon_send_chat_message only for the explicit identical replay. Requires: userId and the player's session: sign in with horizon_signin_email or horizon_signin_anonymous and pass its accessToken as sessionToken. Side effects: Read-only POST, one HTTP attempt. Complete visible ID order plus unknown immutable text. Known IDs are valid only for the exact cached epoch and complete authorized cache. No periodic polling. Returns: {channel,visibleMessageIds,messages,moderation,serverTime}; hide cache on disconnect/permission change and apply only a complete matching snapshot. Errors: 404 hides private/missing/expired channels or source messages. 409 OPERATION_CONFLICT/OPERATION_EXPIRED or STATE_CONFLICT requires explicit original-intent reconciliation. Never replace an unknown send UUID/time/text. 429 does not schedule a retry. CHAT_MUTED/CHAT_BANNED restrict current chat access. 501 NOT_SUPPORTED means simpleServer has no chat or polling fallback. 401 means the session is missing or expired: sign in again and retry with the new accessToken. 403 for a session means the token belongs to another user: pass the userId that signed in. Needs HORIZON_API_KEY. Every failure returns an error result (isError) with the HTTP status and body: a 401 that horizon_test_connection also returns means HORIZON_API_KEY is wrong, 429 means the account's per-minute rate limit was reached (wait a minute, then retry).

Input Schema

NameRequiredDescriptionDefault
epochYesExact cached channel epoch, or null for an initial complete sync
userIdYesActive player matching the current session and project
channelIdYesOriginal canonical lowercase UUID
sessionTokenYesPlayer accessToken sent only as Bearer
knownMessageIdsYesKnown cached message IDs for the exact original epoch; fixed current wire bound20 matches the largest channel window

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.9.1

TDQS

A4.4/5.0
Behavior5/5

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

Annotations only supply readOnly/openWorld/idempotent/destructive flags; the description adds substantial context beyond them: read-only POST with exactly one HTTP attempt, no retry scheduling on 429, cache-epoch validity rules, hide-on-disconnect/permission-change behavior, required HORIZON_API_KEY, and a mapping of 401/403/404/409/429/501 outcomes. Nothing contradicts the readOnlyHint=true annotation.

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 Use when / Not for / Requires / Side effects / Returns / Errors ordering is genuinely front-loaded and scannable, but the block is heavily over-long: error-code enumeration dominates and partially duplicates the usage section (repeated-polling prohibition appears twice, retry guidance repeats). Much of the density could be compressed without information loss.

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-required-parameter authenticated read with no output schema, the description covers prerequisites, auth wiring, return shape ({channel,visibleMessageIds,messages,moderation,serverTime}), cache consistency rules, and failure handling. An agent has everything needed to invoke and interpret it correctly.

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 description coverage is 100%, so the baseline is 3, but the description clarifies the semantics that the schema only hints at: sessionToken must be the accessToken from horizon_signin_email/horizon_signin_anonymous, userId must match the signed-in player, and known IDs are valid only for the exact cached epoch and a complete authorized cache. The epoch null-for-initial-sync case is left to the schema.

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?

States a specific verb and resource: reads an authorized incremental snapshot of a chat channel after a resync event or explicit user action. It differentiates from the send/reconcile siblings (horizon_get_chat_operation, horizon_send_chat_message) by name, but never distinguishes itself from the closest sibling, horizon_open_chat_channel, leaving the read-vs-open boundary implicit.

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?

Explicit 'Use when' and 'Not for' clauses name concrete triggers (after reading horizon://docs/chat, explicit hosted chat actions) and concrete exclusions (automatic sends, repeated polling, rich-text rendering, exposing moderation credentials). It also routes to the correct alternative tools for reconciliation and replay.

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

Deploy Server

Other Tools