Skip to main content
Glama

Get Shared Object Collections

horizon_get_shared_collections
Read-onlyIdempotent

Reads a single permanent collection catalog page to retrieve shared object definitions for world-map or async-PvP access; requires userId and sessionToken.

Instructions

Reads one permanent collection catalog page. Use when: explicit world-map/async-PvP object access after reading horizon://docs/shared-objects. Not for: background polling, automatic page traversal, interpreting opaque bytes or using this as a combat validator. 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; retain catalogRevision across pages. Returns: {revision,definitions,nextAfterKey,limits,serverTime} Errors: 409 revision/state/permission conflict or lost response: explicitly reread owned objects/usage and reconcile original intent, never automatically retry with newer revisions or a replacement ID. 404 does not distinguish missing/private/expired data. 422 retains existing data on quota/archive failure. 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
limitNoExplicit page size from one to fifty; no automatic page traversal
userIdYesActive player UUID matching the authenticated session and project
afterKeyNoPrevious nextAfterKey, omitted on the first catalog page
sessionTokenYesPlayer accessToken, sent only as Bearer
catalogRevisionNoOriginal first-page catalog revision retained across later pages

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.9.1

TDQS

A4.8/5.0
Behavior5/5

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

Goes well beyond the annotations (which only say read-only/idempotent/openWorld). It discloses the pagination contract (retain catalogRevision, nextAfterKey), auth chain (signin → sessionToken), API-key dependency, rate-limit behavior, and a detailed error taxonomy (409 no-retry guidance, 404 ambiguity, 422 quota/archive retention, 401 vs 403 distinction).

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?

Labeled sections (Use when / Not for / Requires / Side effects / Returns / Errors) make it skimmable and front-loaded. The Errors block is dense and long relative to the rest, but each error line carries actionable recovery instructions rather than filler.

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?

No output schema, yet the return shape is enumerated ({revision,definitions,nextAfterKey,limits,serverTime}), pagination state is explained, and all failure modes with remediation are covered. For a paged, session-authenticated read tool, an agent has everything needed to call 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 coverage is already 100%, so the schema carries parameter detail; the description adds cross-page semantics (retain catalogRevision, pass nextAfterKey) that the schema fields only hint at individually. It doesn't add format detail beyond the schema, so a 4 rather than 5.

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 and resource ('Reads one permanent collection catalog page'), and names the domain explicitly (world-map/async-PvP shared objects). Sibling tools like horizon_query_shared_objects, horizon_get_shared_object, and horizon_get_shared_usage exist, and the 'one ... page' + 'permanent catalog' wording distinguishes paged catalog enumeration from those.

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 route the agent: excludes background polling, automatic page traversal, byte interpretation, and use as a combat validator. It also points at horizon://docs/shared-objects as prerequisite reading and names the sign-in siblings to acquire a session.

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