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. Caller must have page 'contribute' permission. 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

TableJSON 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.
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

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. 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"
      +]
  2. First observed

TDQS

A4.5/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 disclosing PUT semantics (supplied fields replace current values), the required fresh baseUpdatedAt with OUT_OF_SYNC rejection and no partial write, the append workaround, and the permission requirement. It contradicts no annotation; idempotentHint is consistent with the atomic no-write 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?

Front-loaded with the core purpose, then progressively adds behavioral detail. The paragraph is a little long but every sentence earns its place, covering semantics, a workaround, a permission, and a required precondition. Some redundancy with the baseUpdatedAt schema description exists, but the importance justifies it.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with 12 parameters, nested objects, and an output schema, the description covers the main complexity: partial update semantics, optimistic concurrency, append pattern, and permission. It relies on the schema for field-level details, which is appropriate given the 83% coverage. It could mention the unusualness of re-anchoring ref, but the schema already notes that.

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?

Although schema coverage is 83%, the description adds critical parameter-level behavior: it explains that supplied fields replace current values (clarifying the semantics of every field) and details the baseUpdatedAt requirement and the append workaround. The schema already describes each field, but the description adds workflow context that the schema cannot.

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 the exact action ('Update a page by id') with a specific verb, resource, and identifier. The PUT semantics line further distinguishes it from create/delete and from other update_* siblings. The name itself already implies the resource, and the description reinforces it.

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?

Provides a concrete pattern for appending to a recap body (fetch via play_get_page, concatenate, send back), which distinguishes update from append scenarios. It also states the required 'contribute' permission as a prerequisite. However, it does not explicitly contrast against play_create_page or other update tools, which would make the when-to-use guidance complete.

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