Skip to main content
Glama

Playbook

by com.playbook
OverviewDiscussionsAdmin

Apply page operations

apply_page_operations
Destructive

Apply up to 50 page edits to a board's published page in order and ATOMICALLY — the first failure rolls everything back, and the error carries operation_index naming the failing operation. Each operation is { type: add|update|move|delete|reorder, ...} with exactly the arguments of the matching single tool (add_page_element etc., minus organization/token/subboard_token/expected_version_token, which are batch-level); operations in get_page_elements_catalog is the authoritative argument map, and unknown keys are refused. Ids the server mints inside a batch cannot be addressed by later operations of the same batch, so give every new element (and a new section's columns) your own id. Returns the whole document (slots) and one summary per operation. Top-level converged appears only when EVERY operation converged, and never on a batch containing an update. One batch edits one document: the main page, or one nested board's section. 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
operationsYesThe edits, e.g. { type: 'delete', slot_id: 'grid', element_id: '<id 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",
-  "operations",
-  "context"
-]New value: +[
+  "token",
+  "operations"
+]
  2. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Far exceeds the annotations (destructive, non-idempotent, open-world) by disclosing atomic rollback, the operation_index on failure, id-minting constraints, permission prerequisites (403 page_layout_api_disabled), compare-and-swap staleness behavior (409 stale_document applies nothing), which 409s are safe to retry, and the up-to-one-hour public propagation delay.

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-loads the atomic batch purpose before the operational detail, and nearly every sentence carries a distinct operational fact. It is nonetheless a dense wall of text that could be tightened, which keeps it short of a 5.

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 complex, destructive, non-idempotent batch mutation with no output schema, the description covers error semantics, concurrency, permissions, and the exact shape of the response (slots, per-operation summaries, converged, materialized) — nothing an agent needs to invoke it 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: it points to get_page_elements_catalog as the authoritative argument map, notes unknown keys are refused, and explains the compare-and-swap role of expected_version_token and the new token returned after a successful write.

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 precise verb and resource — applying up to 50 page edits to a board's published page — plus the defining trait (ordered, atomic). It clearly differentiates itself from the single-operation siblings (add_page_element, update_page_element) by being the batched equivalent.

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?

Gives extensive operational context: each operation takes the arguments of the matching single tool, batch-level params are excluded, and one batch edits exactly one document. However, it never states plainly when an agent should prefer this batch tool over looping the single-tool siblings, leaving that routing decision to inference.

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