Skip to main content
Glama

Get Player Achievements

horizon_get_achievements
Read-onlyIdempotent

Read visible achievement definitions and completion progress to load or refresh a signed-in player's achievements. Use after unlocks or invalidation; read-only, and does not reveal hidden achievements.

Instructions

Reads visible achievement definitions and permanent completion bits. Use when: loading progress or refreshing after newlyUnlocked statistics or realtime invalidation. Not for: changing balances or revealing locked hidden achievements. 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: None (read only). Does not grant anything. Returns: {userId,revision,definitionVersion,definitions,progress,limits,serverTime}. definitions=null retains matching cached definitions; [] clears them. Scope caches to host/project/player/session. Compact progress has rewardState=complete, nullable unknown unlockedAt and no pendingReward/inboxEntryId copy. Legacy unsettled originals remain visible until verified cold settlement. Errors: 409 STATE_CONFLICT: reconcile and retry the same key. ACHIEVEMENT_NOT_MANUAL: report the configured statistic instead. MIGRATION_REQUIRED preserves legacy reward originals for the verified cold operator; it never authorizes a replacement reward or Inbox delivery. 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
userIdYesSigned-in player UUID matching the session
sessionTokenYesPlayer accessToken, sent only as Authorization Bearer
definitionVersionNoOpaque version from the matching cached snapshot; omit for full definitions

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?

The description goes well beyond the annotations by specifying authentication prerequisites, sign-in alternatives, no side effects and no granting behavior, response shape, cache scoping, cache retention semantics, and detailed error handling including 401, 403, 409, 429, ACHIEVEMENT_NOT_MANUAL, and MIGRATION_REQUIRED. The read-only claims are fully consistent with readOnlyHint=true and destructiveHint=false.

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 uses helpful labels such as Use when, Not for, Requires, Side effects, Returns, and Errors. It is information-dense but long, with some highly implementation-specific sentences about compact progress and legacy settlement that are useful but reduce conciseness.

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 read operation with no output schema, the description supplies the return shape, auth requirements, cache behavior, side-effect guarantees, and detailed failure modes. Nothing critical for correct invocation appears to be missing.

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%, so the schema already documents userId, sessionToken, and definitionVersion. The description reinforces the userId/sessionToken relationship and names horizon_signin_email and horizon_signin_anonymous as sources for the accessToken, but it does not meaningfully elaborate on definitionVersion beyond 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?

The description gives a specific verb and resource: reads visible achievement definitions and permanent completion bits. It also distinguishes the operation from mutations and hidden-achievement revelation with explicit 'Not for' language, so an agent can separate it from related achievement and statistics tools.

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?

It states clear usage contexts: loading progress or refreshing after newlyUnlocked statistics or realtime invalidation, and explicitly excludes changing balances and revealing locked hidden achievements. It does not name the best alternative for those excluded cases, such as horizon_unlock_achievement or horizon_get_statistics, which keeps it below a 5.

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