Skip to main content
Glama

Create Shared Object

horizon_create_shared_object
Idempotent

Creates one authenticated shared object for explicit world-map or async-PvP access using the original owner-usage revision; commits object, usage, and quota atomically.

Instructions

Creates one server-ID object using the original owner-usage revision. 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: Commits object, usage and quota atomically. Retain original If-Match after a lost response. One HTTP attempt. Returns: {object,usage,pollAfterSeconds,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
searchYesComplete configured search fields; safe integers or bounded UTF-8 strings
userIdYesActive player UUID matching the authenticated session and project
groupIdNoCurrent immutable group UUID when either collection policy requires a group
positionNoComplete safe-integer grid position when enabled, otherwise null or omitted
collectionYesPermanent collection or configured field key, lowercase ASCII
dataBase64YesOpaque canonical padded Base64 bytes; never interpret or replace them implicitly
sessionTokenYesPlayer accessToken, sent only as Bearer
expectedRevisionYesOriginal reviewed revision; never substitute a newer revision after an uncertain write

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.9.1

TDQS

A4.6/5.0
Behavior5/5

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

Discloses rich behavior beyond the annotations: atomic commit of object, usage, and quota; one HTTP attempt; retaining the original If-Match; return payload; and detailed 401/403/404/409/422/429 semantics. Annotations already indicate readOnly=false, openWorld=true, idempotentHint=true, and destructive=false, and the description adds operational context without clearly contradicting them.

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 description is front-loaded and well-structured with Use when, Not for, Requires, Side effects, Returns, and Errors sections. It is dense and long, with some diagnostic detail that could be trimmed, but most sentences carry useful operational information.

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 complex mutation with no output schema, the description supplies the return shape, auth prerequisites, side effects, and a broad set of failure-mode instructions. It gives an agent enough context to invoke the tool correctly and handle common error states without needing to infer behavior.

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?

With 100% schema description coverage, the baseline is 3; the description adds useful meaning around userId/sessionToken authentication flow, the 403 userId mapping, and treating expectedRevision as the original reviewed revision. It does not add much for collection, search, groupId, or position because those are already well-described in 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 and resource: creates one server-ID shared object using the original owner-usage revision. The 'Use when' and 'Not for' lines make clear it is not a polling, traversal, byte-interpretation, or combat-validation tool.

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

Usage Guidelines4/5

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

Provides explicit when-to-use and when-not-to-use guidance, including reading horizon://docs/shared-objects and avoiding background polling. It also names sign-in tools for authentication, but does not explicitly mention sibling alternatives such as horizon_update_shared_object or horizon_query_shared_objects for related operations.

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