Skip to main content
Glama

Get the SDK reference

get_sdk_reference
Read-only

Returns the full SDK reference (markdown) wired to ONE game's key/endpoints: realtime rooms, player identity (anonymous + claim/login), the datastore (saves/stats/inventory), leaderboards, player-created content (level sharing / UGC), durable shared MATCHES for asynchronous turn-based play, and live ops (live config, scheduled events, highlights). Read this before writing client code that uses logins, saved progress, leaderboards, shared player-made content, or any game a player closes and comes back to. Pass game when the studio has more than one: every snippet carries that game's publishable key inline, and shipping the wrong one silently pools your players into another game. Pass platform "unity" for the Unity / C# SDK variant (C# client code; server logic stays JavaScript).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_sdk_reference"
  }
}

Input Schema

NameRequiredDescriptionDefault
gameNoWhich game to act on: its publishable key (pk_…) or its exact name. Defaults to the x-mp-game header, then your primary game.
platformNoClient platform: "web" (default, the JS SDK for HTML / any web engine) or "unity" (the C# SDK, Unity 2021.2+).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / platform
      Added value: +{
      +  "description": "Client platform: \"web\" (default, the JS SDK for HTML / any web engine) or \"unity\" (the C# SDK, Unity 2021.2+).",
      +  "enum": [
      +    "web",
      +    "unity"
      +  ],
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered; the description adds genuinely useful non-structured context, namely that every snippet carries the game's publishable key inline and that using the wrong one silently pools players into another game. It also notes server logic stays JavaScript for the Unity variant. It does not discuss reference size, versioning, or whether the returned markdown is game-specific snapshot content.

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-loaded with the return value and coverage list, then the usage trigger, then the parameter caveats; every sentence carries information. It is a single dense block with no breaks or bullets, which slightly hurts scanability for a definition this long.

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?

Only two optional parameters, no output schema, and a read-only tool; the description explains the payload format (markdown reference), what it contains, and the risks of misparameterizing. Nothing an agent needs in order to call it correctly is missing.

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 baseline is 3; the description earns extra by explaining the consequence of the `game` parameter (wrong publishable key silently mixes player pools) and clarifying that `platform: unity` yields C# client code while server logic remains JavaScript. Default fallback chain (header then primary game) is left to 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 ("Returns the full SDK reference (markdown)") and enumerates the covered domains: realtime rooms, identity, datastore, leaderboards, UGC, async matches, live ops. It also scopes the output to ONE game's key/endpoints, which distinguishes it from the broader snippet/starter siblings.

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?

Gives clear triggering conditions: "Read this before writing client code that uses logins, saved progress, leaderboards, shared player-made content, or any game a player closes and comes back to." It also explains when to pass `game` (multi-game studios) and when to pass `platform: unity`. It stops short of naming an alternative sibling such as get_client_snippet or stating when this is unnecessary.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.