Skip to main content
Glama

Playbook

by com.playbook
OverviewDiscussionsAdmin

Update page element

update_page_element
DestructiveIdempotent

Replace an element's content on a board's published page. This is a FULL-element replace, not a field patch: every top-level key you send replaces the stored one WHOLESALE, so { props: { text } } DROPS every other stored prop. Read the element with get_page_layout, change what you need, and send its whole props back; top-level keys you omit are left alone. elementType cannot change, and element.id must be omitted or equal element_id. The response never reports converged, even when nothing changed. Requires modify on the board and page-layout API writes enabled for the workspace — otherwise 403 page_layout_api_disabled, which only Playbook can turn on; retrying does not help. Concurrency: pass the version_token from get_page_layout as expected_version_token; if the page changed since, the call answers 409 stale_document and applies NOTHING — read again, re-decide, re-send. A successful write that sent a token returns the NEW version_token: send that on your next write, because your own write already made the old one stale. Of the 409s only lock_wait_timeout and page_layout_library_locked are safe to repeat unchanged. converged: true in the response means nothing changed (the goal state already held); materialized: true means the page had no stored document and this call saved the template's defaults. Both keys are ABSENT when false. The public page can keep showing the old version for up to an hour after a successful write, so a reload may not show the change.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tokenYesBoard token of the published board
elementYes
slot_idYesThe slot holding the element (id or name). A section row is addressed through its slot.
element_idYesId of the element to replace, from get_page_layout.
organizationNoWorkspace slug, as returned by list_organizations. Omit it when the account has a single workspace — it is then resolved from your token. Pass it only when the account has several, or when you mean a workspace other than the obvious one.
subboard_tokenNoEdit a nested board's section of this page instead of the page itself: the `collectionToken` of an entry in get_page_layout's `subboards_settings`. Omit for the main page.
expected_version_tokenNoThe `version_token` from get_page_layout, echoed verbatim to make this write a compare-and-swap. Omit to write unconditionally.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / additionalProperties
      Added value: +false
    • removedInput schema / properties / context
      Removed value: -{
-  "description": "Explain why you are calling this tool and how it fits into the user's overall goal. This parameter is used for analytics and user intent tracking. YOU MUST provide 15-25 words (count carefully). NEVER use first person ('I', 'we', 'you') - maintain third-person perspective. NEVER include sensitive information such as credentials, passwords, or personal data. Example (20 words): \"Searching across the organization's repositories to find all open issues related to performance complaints and latency issues for team prioritization.\"",
-  "type": "string"
-}
    • changedInput schema / required
      Previous value: -[
-  "token",
-  "element_id",
-  "slot_id",
-  "element",
-  "context"
-]New value: +[
+  "token",
+  "element_id",
+  "slot_id",
+  "element"
+]
  2. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only flag it as destructive/idempotent/open-world; the description goes far beyond that with wholesale-replace semantics, immutable elementType, the 403 page_layout_api_disabled condition, 409 stale_document applying NOTHING, converged/materialized flags being absent when false, and up-to-an-hour propagation delay on the public page.

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 replace-vs-patch warning is front-loaded and the paragraph is organized by concern (semantics, errors, concurrency, response flags), so the density is justified. It runs long and could be trimmed slightly, but essentially every sentence carries operational information.

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?

No output schema exists, and the description compensates by explaining every response signal (new version_token, converged, materialized, absent-when-false) plus the stale-read window. For a destructive, token-gated write with nested params, nothing an agent needs is missing.

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 high (86%), so the baseline is 3, and the description earns above that by explaining semantics the schema only hints at: props keys replace WHOLESALE, element.id must be omitted or match element_id, expected_version_token acts as compare-and-swap, and omitted top-level keys are left alone.

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 a specific verb and resource ('Replace an element's content on a board's published page') and immediately distinguishes its semantics from a field patch. It also names the companion read tool (get_page_layout), so an agent can differentiate it from add_page_element, delete_page_element, and move_page_element.

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?

Gives an explicit workflow ('read with get_page_layout, change what you need, send its whole props back'), states the prerequisite ('requires modify and page-layout API writes enabled ... retrying does not help'), identifies which 409s are safe to repeat, and describes how to thread version_token between writes. When-to-use and when-not-to-use are both covered.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Playbook toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources