Skip to main content
Glama

Embers: Tabletop RPG Toolkit

Update a page

play_update_page
Idempotent

Update a page by id. PUT semantics — supplied fields replace their current values. To append to a recap body, fetch first via play_get_page, concatenate, and send back. Allowed for the page's owner, an admin with Admin Mode on, or the GM of the page's campaign for a page the table sees (a public page, or a GM-side page: dm-notes, campaign-logistics); a player's private pages and recaps answer to their author (or an admin with Admin Mode on) alone. REQUIRES baseUpdatedAt: copy updatedAt from a fresh play_get_page read; a stale or fabricated value is rejected with OUT_OF_SYNC and nothing is written — writing from memory of an earlier read is not possible.

Input Schema

NameRequiredDescriptionDefault
idYesMongo `_id` of the page to update.
refNoWhat the page is attached to. Required for character notes; optional for free-form pages. Allowed on update too (Mongoose has no immutability constraint), though re-anchoring a page is unusual.
linkNoURL-safe slug. Lowercase letters, numbers, and hyphens only. Setting or changing a page link needs Premium, VIP, or admin.
nameNoPage name / title.
activeNo
publicNo
summaryNoShort page summary. Max 255 characters.
keywordsNoComma-separated keyword string.
promptIdNoMongo `_id` reference (24-character hex string).
descriptionNoMarkdown body.
documentTypeNoWhat kind of page this is. Defaults to 'generic'. Use 'player-recap' for a session recap.
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.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / link / description
      Previous value: -"URL-safe slug. Lowercase letters, numbers, and hyphens only."New value: +"URL-safe slug. Lowercase letters, numbers, and hyphens only. Setting or changing a page link needs Premium, VIP, or admin."
  2. Changed15 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": "Markdown body.",
      +  "type": "string"
      +}
    • addedInput schema / properties / documentType
      Added value: +{
      +  "description": "What kind of page this is. Defaults to 'generic'. Use 'player-recap' for a session recap.",
      +  "enum": [
      +    "generic",
      +    "player-recap",
      +    "dm-notes",
      +    "player-notes",
      +    "campaign-logistics"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / id
      Added value: +{
      +  "description": "Mongo `_id` of the page to update.",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / keywords
      Added value: +{
      +  "description": "Comma-separated keyword string.",
      +  "type": "string"
      +}
    • addedInput schema / properties / link
      Added value: +{
      +  "description": "URL-safe slug. Lowercase letters, numbers, and hyphens only.",
      +  "pattern": "^[a-z0-9-]+$",
      +  "type": "string"
      +}
    • addedInput schema / properties / name
      Added value: +{
      +  "description": "Page name / title.",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / promptId
      Added value: +{
      +  "description": "Mongo `_id` reference (24-character hex string).",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / public
      Added value: +{
      +  "type": "boolean"
      +}
    • addedInput schema / properties / ref
      Added value: +{
      +  "additionalProperties": {},
      +  "description": "What the page is attached to. Required for character notes; optional for free-form pages. Allowed on update too (Mongoose has no immutability constraint), though re-anchoring a page is unusual.",
      +  "properties": {
      +    "refId": {
      +      "minLength": 1,
      +      "type": "string"
      +    },
      +    "refType": {
      +      "enum": [
      +        "campaign",
      +        "session",
      +        "character"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
    • addedInput schema / properties / summary
      Added value: +{
      +  "description": "Short page summary. Max 255 characters.",
      +  "maxLength": 255,
      +  "type": "string"
      +}
    • addedInput schema / required
      Added value: +[
      +  "id",
      +  "baseUpdatedAt"
      +]
  3. First observed

TDQS

A4.6/5.0
Behavior5/5

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

With annotations covering the safety/idempotency profile, the description still adds substantial behavioral context: optimistic concurrency via baseUpdatedAt, the OUT_OF_SYNC rejection with a guarantee that 'nothing is written', the append-vs-replace distinction, and detailed ownership rules. It also warns that writing from memory of an earlier read is not possible — genuinely non-obvious behavior.

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?

Content is front-loaded ('Update a page by id. PUT semantics...') and the append guidance appears before the permission wall. The permission sentence is long and clause-heavy, but each clause encodes a distinct authorization case rather than filler; the baseUpdatedAt sentence slightly restates the schema but earns its place by explaining the OUT_OF_SYNC failure mode.

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 nested objects, an output schema, and full annotations, the description supplies the missing pieces an agent must know — auth rules, concurrency contract, replace-vs-append semantics — and correctly omits return-value documentation since an output schema exists.

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 83%, so the baseline is already 3, but the description adds real meaning for baseUpdatedAt (it is proof-of-freshness, not just a timestamp, and must be copied verbatim from a fresh read) and clarifies the replace-vs-append semantics for body fields. It doesn't explain other params such as link's Premium requirement beyond what the schema already states.

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 states a specific verb+resource ('Update a page by id') and immediately qualifies the semantics ('PUT semantics — supplied fields replace their current values'), which distinguishes it from play_create_page, play_delete_page, and play_get_page. An agent knows exactly what operation this is without opening the schema.

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 explicitly routes the agent to `play_get_page` for the fetch-append-send workflow and spells out the authorization conditions that gate usage (owner, Admin Mode admin, campaign GM for public/dm-notes/campaign-logistics pages). It does not, however, address when to prefer it over near-neighbors like play_update_character_note, play_update_move, or play_update_session, so the sibling routing is only partial.

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