Skip to main content
Glama

Get a carousel

get_carousel
Read-only

Get the status and result of a carousel in a workspace. status is queued, processing, completed, or failed. When completed, returns the title, a caption you can use as the post text, the editor URL, and the rendered slide images in order with their mediaIds. images is empty when the carousel was edited in Posteady after its last render. A failed status includes an error code and message; generation credits are refunded unless the message says the carousel was saved. This reads stored state and never starts a new generation.

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": {
      "carouselId": "<carouselId>"
    },
    "name": "get_carousel"
  }
}

Input Schema

NameRequiredDescriptionDefault
carouselIdYescarouselId returned by create_carousel.
workspaceIdNoWorkspace of the carousel. Defaults to the token's workspace.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already cover read-only and safety, and the description goes well beyond them: the four status values, the exact payload returned on completion, the edge case where images is empty after a Posteady edit, and the refund semantics on failure. That failure/credit detail is exactly the kind of consequence an agent cannot infer from annotations or schema.

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?

Purpose is front-loaded and every sentence carries information: status values, return payload, the empty-images edge case, failure semantics, and the read-only clarification. The single dense paragraph could be split for scannability, but there is no filler.

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?

There is no output schema, so the description has to carry return-value semantics, and it does: title, caption, editor URL, ordered slide images with mediaIds, plus the empty-images and failure cases. For a two-parameter read tool, nothing an agent needs to interpret the response is missing.

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% and both parameters are documented in the schema, including that carouselId comes from create_carousel and that workspaceId defaults to the token's workspace. The description adds no parameter-level meaning, so the baseline applies.

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 and resource ("Get the status and result of a carousel in a workspace") and explicitly distinguishes itself from the write path with "This reads stored state and never starts a new generation," which separates it from sibling create_carousel.

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 closing sentence makes the read-only use case clear and implicitly positions this as the follow-up to create_carousel, and the status enumeration implies polling until completed. It doesn't name a sibling alternative explicitly or say when not to call it (e.g., versus get_publish_status for posts), so it stops short of full routing guidance.

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