Skip to main content
Glama

Get page layout

get_page_layout
Read-only

Read the stored design of a board's published page: template, the page's own background_color and typography (null = inherited), slots (the page's regions and their elements), subboards_settings (one full second document per nested board shown on the page) and version_token. Returned verbatim — the ids and camelCase keys are exactly what the page element tools take back. slots: null is NORMAL for a page nobody has edited yet: it still renders its template's defaults. Address such a page by slot NAME (see templates in get_page_elements_catalog); the first write stores the defaults and returns real ids. 404 page_layout_not_found means the board has no page design — publish it with publish_board and a template first. Reads never change anything and are not gated by the page-layout write flag.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tokenYesBoard token of the published board
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.

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.4/5.0
Behavior5/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description adds substantial context beyond them: the verbatim return contract (ids/camelCase keys match the element tools), the meaning of slots:null, the first-write-stores-defaults lifecycle, the 404 error code semantics, and that reads bypass the page-layout write flag.

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?

A dense but well-ordered block that front-loads the purpose and return contents before edge cases. It is somewhat long, and given there is no output schema the extra detail on lifecycle and errors mostly earns its place, though minor compression would help.

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 fully compensates by explaining every returned field, the null/inheritance semantics, and the 404 path. An agent has everything needed to call it correctly and interpret the result.

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 coverage is 100%, so both token and organization are fully documented in the schema itself, including the organization-omission guidance. The description adds no parameter-specific syntax or format detail, so baseline 3 is appropriate.

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?

Names a specific verb+resource: reading the stored design of a board's published page, and enumerates exactly the fields returned (template, background_color, typography, slots, subboards_settings, version_token). An agent can immediately distinguish this from sibling page tools like get_page_elements_catalog which return element catalogs.

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 concrete conditions: use publish_board with a template when 404 page_layout_not_found occurs, address unedited pages by slot name via get_page_elements_catalog, and notes reads aren't gated by the write flag. It lacks an explicit 'use X instead when...' comparison against sibling element-read tools, but the contextual routing is strong.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources