Skip to main content
Glama

Update Shared Object

horizon_update_shared_object
DestructiveIdempotent

Replaces a shared object's opaque bytes and search data at its exact revision for explicit world-map or async-PvP access. Requires a signed-in player session and current owner/group permission.

Instructions

Replaces one object's opaque bytes and configured search data under its exact 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: Current owner/group permission required; owner/group/expiry stay immutable. 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
objectIdYesOriginal server-generated object UUID from the reviewed snapshot
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.4/5.0
Behavior3/5

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

Annotations already declare destructive=true, idempotent=true, and openWorld=true, and the description correctly reinforces the immutable owner/group/expiry constraint and the single HTTP attempt. It also details the 409/401/403/422/429 failure semantics and explicitly warns against automatic retry with newer revisions, which is genuinely useful guidance beyond the annotations.

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?

Front-loads the core action, then layers use-when, requires, side effects, returns, and errors in scannable order. The error block is long but each clause carries distinct recovery guidance, so it earns its space.

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?

Covers returns shape, permission requirements, immutability constraints, and detailed error recovery for a destructive mutation with no output schema and nested parameters. An agent has what it needs to invoke and recover without guessing.

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 100%, so the description only needs to reinforce meaning. It does add operational context around expectedRevision ('never substitute a newer revision after an uncertain write') and the sessionToken/userId pairing, though most per-field detail is already 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: replaces one object's opaque bytes plus configured search data, pinned to an exact revision. This clearly separates it from horizon_create_shared_object, horizon_get_shared_object, and horizon_delete_shared_object in the sibling list.

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?

Gives an explicit 'Use when' clause tied to world-map/async-PvP object access, plus a 'Not for' list ruling out polling, page traversal, byte interpretation, and combat validation. It also names the prerequisite sign-in tools that produce the sessionToken.

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