Skip to main content
Glama

Embers: Tabletop RPG Toolkit

Update a character note (DM or player)

play_update_character_note
Idempotent

Update the DM-side or player-side note attached to a play character. PUT semantics — description replaces the current body. Authorization runs through the character's campaign 'contribute' permission. Triggers a notification (to the character owner if a GM updated, to GMs if a player updated). REQUIRES baseUpdatedAt: copy updatedAt from a fresh play_get_character_note read of the same note; a stale or fabricated value is rejected with OUT_OF_SYNC and nothing is written.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoOptional new name for the note.
characterIdYesMongo `_id` of the play character (NOT the vault character id).
descriptionYesNote body markdown. PUT semantics: replaces the existing body.
documentTypeYesWhich note to update: 'dm-notes' or 'player-notes'.
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. Changed8 schema fields changed
    • addedInput schema / $schema
      Added value: +"http://json-schema.org/draft-07/schema#"
    • addedInput schema / additionalProperties
      Added value: +{}
    • 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 / characterId
      Added value: +{
      +  "description": "Mongo `_id` of the play character (NOT the vault character id).",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / properties / description
      Added value: +{
      +  "description": "Note body markdown. PUT semantics: replaces the existing body.",
      +  "type": "string"
      +}
    • addedInput schema / properties / documentType
      Added value: +{
      +  "description": "Which note to update: 'dm-notes' or 'player-notes'.",
      +  "enum": [
      +    "dm-notes",
      +    "player-notes"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / name
      Added value: +{
      +  "description": "Optional new name for the note.",
      +  "minLength": 1,
      +  "type": "string"
      +}
    • addedInput schema / required
      Added value: +[
      +  "characterId",
      +  "baseUpdatedAt",
      +  "documentType",
      +  "description"
      +]
  2. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Despite annotations covering readOnlyHint=false, idempotentHint=true, and destructiveHint=false, the description adds valuable behavioral context: the authorization path, the notification triggers, the concurrency check (OUT_OF_SYNC), and the guarantee that nothing is written on failure. These go beyond the annotations and are critical for correct invocation.

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 efficient: every sentence contributes necessary information. It front-loads the main action, then covers semantics, auth, notification, and the critical concurrency requirement. No filler or redundancy; the length is justified by the complexity of the operation.

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 write operation with concurrency controls and side effects, the description is complete. It covers the operation, authorization, notification behavior, the required prerequisite, failure mode, and the response containing the new updatedAt. With an output schema present, nothing essential is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema already provides detailed descriptions for all five parameters, with 100% coverage. The tool description adds the PUT semantics context and reiterates the baseUpdatedAt requirement, but these are also present in the schema. Thus the description adds marginal value beyond the schema, matching the baseline of 3.

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 verb (update), the resource (character note), and distinguishes between DM-side and player-side notes. It also mentions PUT semantics, which clarifies the replacement behavior. This is specific enough to differentiate from sibling tools like play_get_character_note or vault_update_character.

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?

The description explicitly instructs the agent to copy baseUpdatedAt from a fresh play_get_character_note read, states the rejection behavior for stale values, and clarifies the authorization requirement via the campaign's 'contribute' permission. It also notes the notification side effect. This gives clear when-to-use guidance and a mandatory prerequisite.

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