Skip to main content
Glama

Embers: Tabletop RPG Toolkit

Update a play campaign

play_update_campaign
Idempotent

PUT updates to one campaign by id. Caller must be the campaign's owner, an admin with Admin Mode on, or the campaign's GM (an accepted gamemaster). Play writes only name, summary, description, image, public, hideSections, dismissedSessionZeroNudge, xCardEnabled, showCreatureDetails, and autoRollInitiative, plus active for the owner or an admin with Admin Mode on, and ignores any other field; seats change only through the invite tools; making the campaign public needs Premium, VIP, or admin. Only supplied fields are sent. legs is NOT writable here (it is stripped): add a leg with play_add_campaign_leg, toggle one with play_set_campaign_leg_active, and change a leg's contents with the add/remove rule/item/spell/character tools. REQUIRES baseUpdatedAt: copy updatedAt from a fresh play_get_campaign read; a stale or fabricated value is rejected with OUT_OF_SYNC and nothing is written.

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": {
      "id": "<id>",
      "baseUpdatedAt": "<baseUpdatedAt>"
    },
    "name": "play_update_campaign"
  }
}

Input Schema

NameRequiredDescriptionDefault
idYesMongo `_id` of the campaign.
nameNoCampaign name.
imageNoImage URL. Stored as a plain string.
activeNo
publicNoWhether non-members can see the campaign. Making the campaign public needs Premium, VIP, or admin.
summaryNoShort campaign summary. Max 150 characters.
descriptionNoFull campaign description. Markdown supported.
hideSectionsNo
xCardEnabledNo
baseUpdatedAtYesREQUIRED proof that you are working from the latest version: copy the `updatedAt` value verbatim from a FRESH read of this exact record (use the matching get tool first). Values from memory, from an earlier conversation, or guessed timestamps are rejected with OUT_OF_SYNC and nothing is written. After a successful update, the response carries the new `updatedAt` — use that for any follow-up write.
autoRollInitiativeNoWhether a token placed on the campaign's battlemaps gets its initiative rolled (a d20 plus its character's initiative bonus) when it joins the initiative order. Only tokens backed by a character in a ruleset with an initiative roll are rolled; every other token joins unscored. A battlemap rolls only when every one of its campaigns has this on. On by default.
showCreatureDetailsNoWhether players see a creature's details (its health and armor class, per ruleset) at the top of a token's details on the campaign's battlemaps. A battlemap shows them only when every one of its campaigns has this on. Off by default.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed5 schema fields changed
    • addedInput schema / properties / autoRollInitiative
      Added value: +{
      +  "description": "Whether a token placed on the campaign's battlemaps gets its initiative rolled (a d20 plus its character's initiative bonus) when it joins the initiative order. Only tokens backed by a character in a ruleset with an initiative roll are rolled; every other token joins unscored. A battlemap rolls only when every one of its campaigns has this on. On by default.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / hideSections / properties / items
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / hideSections / properties / moves
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / hideSections / properties / partyOrder
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / hideSections / properties / spells
      Added value: +{
      +  "type": "boolean"
      +}
  2. Changed1 schema field changed
    • addedInput schema / properties / showCreatureDetails
      Added value: +{
      +  "description": "Whether players see a creature's details (its health and armor class, per ruleset) at the top of a token's details on the campaign's battlemaps. A battlemap shows them only when every one of its campaigns has this on. Off by default.",
      +  "type": "boolean"
      +}
  3. Changed2 schema fields changed
    • changedInput schema / properties / public / description
      Previous value: -"Whether non-members can see the campaign."New value: +"Whether non-members can see the campaign. Making the campaign public needs Premium, VIP, or admin."
    • removedInput schema / properties / sessions
      Removed value: -{
      -  "items": {
      -    "description": "Mongo `_id` reference (24-character hex string).",
      -    "minLength": 1,
      -    "type": "string"
      -  },
      -  "type": "array"
      -}
  4. Changed14 schema fields changed
    • addedInput schema / $schema
      Added value: +"http://json-schema.org/draft-07/schema#"
    • addedInput schema / additionalProperties
      Added value: +{}
    • addedInput schema / properties / active
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / baseUpdatedAt
      Added value: +{
      +  "description": "REQUIRED proof that you are working from the latest version: copy the `updatedAt` value verbatim from a FRESH read of this exact record (use the matching get tool first). Values from memory, from an earlier conversation, or guessed timestamps are rejected with OUT_OF_SYNC and nothing is written. After a successful update, the response carries the new `updatedAt` — use that for any follow-up write.",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / description
      Added value: +{
      +  "description": "Full campaign description. Markdown supported.",
      +  "type": "string"
      +}
    • addedInput schema / properties / hideSections
      Added value: +{
      +  "additionalProperties": {},
      +  "properties": {
      +    "characters": {
      +      "type": "boolean"
      +    },
      +    "logistics": {
      +      "type": "boolean"
      +    },
      +    "players": {
      +      "type": "boolean"
      +    },
      +    "rules": {
      +      "type": "boolean"
      +    },
      +    "safetyTools": {
      +      "type": "boolean"
      +    },
      +    "sessionZero": {
      +      "type": "boolean"
      +    },
      +    "sessions": {
      +      "type": "boolean"
      +    }
      +  },
      +  "type": "object"
      +}
    • addedInput schema / properties / id
      Added value: +{
      +  "description": "Mongo `_id` of the campaign.",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / image
      Added value: +{
      +  "description": "Image URL. Stored as a plain string.",
      +  "type": "string"
      +}
    • addedInput schema / properties / name
      Added value: +{
      +  "description": "Campaign name.",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / public
      Added value: +{
      +  "description": "Whether non-members can see the campaign.",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / sessions
      Added value: +{
      +  "items": {
      +    "description": "Mongo `_id` reference (24-character hex string).",
      +    "minLength": 1,
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / summary
      Added value: +{
      +  "description": "Short campaign summary. Max 150 characters.",
      +  "maxLength": 150,
      +  "type": "string"
      +}
    • addedInput schema / properties / xCardEnabled
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / required
      Added value: +[
      +  "id",
      +  "baseUpdatedAt"
      +]
  5. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Beyond the annotations, the description discloses authorization rules, partial-update semantics ('only supplied fields are sent'), ignored fields, the restricted `active` field, Premium/VIP/admin requirements for public campaigns, and optimistic concurrency with OUT_OF_SYNC failure behavior. This is exactly the kind of behavioral context the annotations alone do not provide.

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 with the core operation and then covers authorization, field restrictions, alternatives, and concurrency requirements. It is dense but justified by the tool's complexity; minor redundancy exists between 'ignores any other field' and 'Only supplied fields are sent,' and the single-paragraph format reduces scanability.

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 12-parameter mutation tool with an output schema, the description covers everything an agent needs before calling: permissions, writable fields, excluded fields and their alternatives, subscription constraints, and stale-write protection. Return-value details can be left to the output schema.

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 75%, and the description adds meaningful parameter context: `active` is conditionally writable only for owners or Admin Mode admins, `public` has a subscription requirement, and `legs` is deliberately not writable here. The baseUpdatedAt semantics largely repeat the schema description, and one listed writable field (`dismissedSessionZeroNudge`) does not appear in the schema, so it is not a perfect parameter-level supplement.

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 opens with a specific verb and resource ('PUT updates to one campaign by id') and immediately scopes the operation with an explicit writable-field whitelist. It also names the sibling tools that handle legs (play_add_campaign_leg, play_set_campaign_leg_active), so an agent can distinguish this tool from related mutation tools without opening a schema.

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 states exactly who may call it (owner, admin with Admin Mode on, or accepted GM), what it will and will not write, and routes leg changes to named alternative tools. It adds prerequisites for making a campaign public and explains the required fresh-read pattern for baseUpdatedAt, leaving little inference.

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.

Resources