Playbook

Add page element

add_page_element

Insert one element into a slot of a board's published page, or into a column of a section element when parent_element_id is given. Returns the slot as it now stands plus element_id. Supply element.id yourself: re-sending the same add then converges (200, nothing inserted), while the same id with DIFFERENT content is 409 element_exists — pick another id or use update_page_element. Props that carry HTML or a URL must be strings. An asset_token prop takes a token from list_assets; the server copies that asset into the page's library and stores the copy's token. To add several elements, or a section plus its contents, prefer apply_page_operations (atomic). 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

Name	Required	Description
`token`	Yes	Board token of the published board
`element`	Yes
`slot_id`	Yes	A slot's id from get_page_layout, or its NAME (e.g. `menu`, `grid`). Use the name when get_page_layout reports `slots: null`: the write stores the template defaults and the response carries real ids to address from then on.
`at_index`	Yes	0-based position in the slot (or column). Past the end appends.
`column_id`	No	Id to give a column this call CREATES (with create_new_column, or when column_index is past the last column). It does NOT pick an existing column: without column_index the element lands in column 0. Address an existing column with column_index.
`column_index`	No	Section column to insert into, by 0-based position.
`organization`	No	Workspace 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_token`	No	Edit 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.
`create_new_column`	No	Create a new column in the section for this element.
`parent_element_id`	No	Insert into this `section` element's columns instead of at slot top level.
`expected_version_token`	No	The `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.

Changed3 schema fields changedOct 5, 2026

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",
-  "slot_id",
-  "at_index",
-  "element",
-  "context"
-]New value: +[
+  "token",
+  "slot_id",
+  "at_index",
+  "element"
+]

First observedOct 2, 2026

TDQS

A4.8/5.0

Behavior5/5

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

Goes far beyond the annotations, which only give readOnly/destructive/openWorld hints. It discloses the idempotency contract (same id + same content converges; same id + different content is 409 element_exists), the compare-and-swap semantics of expected_version_token, which 409s are safe to repeat, the converged/materialized response keys and their absence-when-false convention, and a one-hour public-page staleness window.

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 action and scope, then layered into error, concurrency, and response semantics; virtually every sentence carries operational weight. It is long and dense, but the length is justified by the tool's complexity rather than padding.

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 still explains the return payload (the slot as it now stands, element_id, the new version_token, converged/materialized flags), plus auth failures, concurrency conflicts, and caching delays. Nothing an agent needs to call it correctly is absent.

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 already 91%, so the schema carries most parameter meaning, but the description adds real value: element.id as an idempotency token, props carrying HTML/URL must be strings, asset_token is copied into the page library, and expected_version_token is an echoed compare-and-swap value. The column_id vs column_index distinction is covered in the schema rather than the prose, leaving little to add.

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?

Opens with a specific verb+resource+scope: insert one element into a slot of a published page, or into a section column when parent_element_id is given. It also names the sibling it differs from (update_page_element for changes, apply_page_operations for batches), so the agent can distinguish it without opening any schema.

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?

Explicit routing: use update_page_element when the same id carries different content, and prefer apply_page_operations for several elements or a section plus contents (atomic). It also states the permission precondition (modify + page-layout API writes) and which errors are safe to retry versus which are not.

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

All Playbook tools Inspect

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

Need Help?