Skip to main content
Glama

Playbook

by com.playbook
OverviewDiscussionsAdmin

Reorder page slot

reorder_page_slot
DestructiveIdempotent

Set the order of a slot's top-level elements on a board's published page. ordered_ids must be EXACTLY the slot's current top-level element ids — none missing, none repeated, none extra (ids nested in a section count as extra) — otherwise 422 reorder_id_mismatch names the offending ids and nothing changes. An order that already holds converges. To move one element, move_page_element is simpler. 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

NameRequiredDescriptionDefault
tokenYesBoard token of the published board
slot_idYesThe slot to reorder (id or name).
ordered_idsYesEvery top-level element id of the slot, in the wanted order.
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",
-  "slot_id",
-  "ordered_ids",
-  "context"
-]New value: +[
+  "token",
+  "slot_id",
+  "ordered_ids"
+]
  2. First observed

TDQS

A4.6/5.0
Behavior5/5

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

With annotations present (readOnlyHint=false, destructiveHint=true, idempotentHint=true, openWorldHint=true), the bar for extra behavioral disclosure is lower, yet the description goes far beyond them. It explains the 422 reorder_id_mismatch error path, 403 page_layout_api_disabled, 409 stale_document semantics, which 409s are safe to retry, that the write is compare-and-swap via expected_version_token, that a successful write rotates the token, and that the public page can lag up to an hour. This is exactly the kind of write-behavior context annotations cannot provide.

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 core action and constraint, then organized into paragraphs for errors, concurrency, and response flags. It is dense but every clause carries operational weight; it is slightly over-detailed with dual error-path and token-protocol sections, keeping it just below the high bar for conciseness.

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 6-parameter, three-required write tool with no output schema, the description covers everything an agent needs: required input semantics, exact error codes, idempotency/retry rules, version-token handling, and response flag behavior. Nothing material is missing, and it correctly does not attempt to explain a return value that has no schema.

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?

Schema description coverage is 100%, so all six parameters are already documented in the schema, including token, slot_id, ordered_ids, organization, subboard_token, and expected_version_token. The description adds operational meaning for ordered_ids (exact match required, nested ids count as extra) and the token semantics, but the schema already covers the basics. Baseline 3 is appropriate when the schema does the heavy lifting.

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 (Set the order) and resource (a slot's top-level elements on a board's published page), introspected from the very first sentence. It also names the simpler sibling move_page_element for a single-element move, so it is clearly distinguishable from alternatives.

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?

Explicitly says to use move_page_element when moving one element, and lays out the concurrency protocol. It also states the exact requirement (modify on board and page-layout API writes enabled) and what to do when they're missing, so the agent knows when and when-not to use this tool.

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