Skip to main content
Glama

Show or hide a character on the Master HUD

set_character_on_hud
Idempotent

Take a character off the GM's Master HUD (a one-shot's pregen, somebody away for a while) or put them back. Nothing else changes: the sheet, who holds it and the journal stay as they are. list_characters says who is off as offHud. GM only. Returns: { ok, slug, shown }.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "campaign": "<campaign>",
      "character": "<character>",
      "shown": "<shown>"
    },
    "name": "set_character_on_hud"
  }
}

Input Schema

NameRequiredDescriptionDefault
shownYestrue puts them on the Master HUD, false takes them off.
campaignYesThe campaign, by its slug (what its link says) or its id.
characterYesThe character, by its slug.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.9/5.0
Behavior5/5

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

The description offers behavioral traits beyond the annotations, specifically mentioning the scope ('GM only'), the context ('one-shot's pregen'), and critical constraints regarding state preservation (e.g., 'the sheet... stay as they are'). This provides high-value context that the annotations lack.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is highly concise, using two sentences to define the action, the limitations, and the scope. It front-loads the action and provides a concise definition of the context.

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?

Given the tool's state-change nature, the description is exceptionally complete. It defines the environment, the expected behavioral limits, and the return structure, leaving no ambiguity for the agent.

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?

Since schema coverage is 100%, the baseline is already high. The description adds semantic clarity by clarifying that the 'shown' boolean is the on/off switch for HUD visibility, reinforcing the meaning of each required parameter within the operational context.

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 clearly states the tool's function—to take a character off or put them back on the Master HUD. It provides specific context that differentiates this action from general character management tools, naming the GM's Master HUD and its use in one-shot pregen.

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?

It provides explicit constraints on usage by stating that 'nothing else changes' regarding sheets, journal, or holding roles. This effectively sets boundaries on user expectations and ensures the agent does not attempt to resolve collateral issues.

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.