Skip to main content
Glama

Playbook

by com.playbook
OverviewDiscussionsAdmin

Update page settings

update_page_settings
DestructiveIdempotent

Change a board's published page's own background colour and/or typography. A PARTIAL update: a setting you do not name is left as it is; one sent as null is CLEARED and the page inherits it again (from the template; a cleared nested-board section inherits the page first). Legal values are background_colors and typographies in get_page_elements_catalog. Elements are untouched. If the board followed a workspace template, a real change detaches it so a later template roll-out does not revert it. 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
typographyNoNew typography, or null to clear it. Omit to leave it unchanged.
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.
background_colorNoNew background colour, or null to clear it. Omit to leave it unchanged.
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",
-  "context"
-]New value: +[
+  "token"
+]
  2. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Exceptionally rich disclosures well beyond the annotations: template detachment on real change, the 403 page_layout_api_disabled prerequisite that retrying cannot fix, 409 stale_document applying nothing, which 409s are safe to repeat, the rotated version_token contract, and converged/materialized response flags. It also warns the public page can serve the old version for up to an hour. This is far past what destructiveHint/idempotentHint convey.

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?

It is long and dense, but front-loaded with the core operation and then ordered by concern (semantics, prerequisites, concurrency, response flags, caching). Nearly every sentence carries operational weight; only the restatement of omit/null semantics slightly overlaps the schema.

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?

With no output schema, the description must carry return-value meaning, and it does: version_token rotation, converged, and materialized flags including their absent-when-false convention. Combined with auth prerequisites, error taxonomy, and concurrency guidance, nothing an agent needs to call this correctly 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 100%, so the baseline is 3, but the description adds real meaning: the inheritance rule for cleared values ('inherits from the template; a cleared nested-board section inherits the page first'), the subboard_token targeting semantics, and the compare-and-swap contract for expected_version_token. The omit-vs-null distinction largely duplicates the schema wording, which keeps this at 4 rather than 5.

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 and resource ('Change a board's published page's own background colour and/or typography') and immediately scopes it away from element editing ('Elements are untouched'), which cleanly separates it from update_page_element and add_page_element. An agent knows exactly what this tool mutates versus its closest siblings.

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 gives concrete decision rules (omit = unchanged, null = cleared, subboard_token = edit a nested section, expected_version_token = compare-and-swap) and names supporting tools (get_page_elements_catalog, get_page_layout, list_organizations). It stops short of explicitly stating when to choose update_page_element or apply_page_operations instead, so it is clear context rather than full when/when-not routing.

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