Skip to main content
Glama

Get Carousel Board

carousels_board_get
Read-onlyIdempotent

Read a carousel board: revision, caption, pending AI images and a summary of every slide with its elements in paint order (ID, type, parent, text, image source, box in slide pixels, font, color, hidden, locked), plus the brand theme and saved themes. carousels_board_edit targets these IDs and theme ids. view full adds the board composition (editor element model; colors may be brand tokens like var(--br-accent); media sources are asset:, brand:logo or bundled paths). slideIds limits the summary to those slides.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "projectId": "<projectId>",
      "view": "<view>",
      "slideIds": "<slideIds>"
    },
    "name": "carousels_board_get"
  }
}

Input Schema

NameRequiredDescriptionDefault
viewYessummary
slideIdsYesOnly these slides in the summary; null returns every slide
projectIdYesUUID string.
workspaceIdNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive/closed-world, and the description adds substantive return-shape behavior: elements come back in paint order, media sources are encoded as asset:<id>, brand:logo or bundled paths, and colors in full view may be brand tokens like var(--br-accent). It does not discuss permissions, board-size limits, or cost of the full view, so it stops short of a 5.

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 purpose and the read-to-edit relationship, then the mode/parameter notes. The long parenthetical element list (ID, type, parent, text, ...) is dense and slightly hard to scan, but each enumerated item carries real information about the payload.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a 4-parameter read tool with an output schema, annotations and a schema that already documents two of four params, the description covers the important behavioral nuances (paint order, token-encoded colors, asset ID formats, mode differences) that the schema cannot express. Only workspaceId scoping goes unexplained.

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?

With only 50% schema description coverage, the description compensates well: it explains what view=full adds versus summary, and that slideIds restricts the summary to those slides. projectId's role as the board identifier is implied rather than stated, and workspaceId is never mentioned, leaving a partial gap.

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 ('Read a carousel board') and then enumerates exactly what is returned: revision, caption, pending AI images, per-slide element summaries in paint order, brand theme and saved themes. It also distinguishes itself from the sibling write path by stating that carousels_board_edit targets the IDs this tool returns.

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?

The sentence 'carousels_board_edit targets these IDs and theme ids' establishes the read-then-edit workflow and makes clear this is the discovery step for mutations. 'view full adds the board composition' and 'slideIds limits the summary to those slides' give conditional guidance for the two modes, but no explicit when-not-to-use or comparison against other read siblings is given.

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