Skip to main content
Glama

List segments

get_segments
Read-onlyIdempotent

List the storyboard's segments (narration span, type, duration, creative direction). The 1-based segment_number is the handle every segment tool takes (update/split/combine/continuation/regenerate) — you never need a UUID. Returns {total, offset, returned, segments}; on big projects page through with offset/limit rather than fetching all segments in one call.

Each segment reports `continues_from_segment`: when set, this shot
CONTINUES that earlier segment's frame (same composition, only the delta
changes); null is a fresh shot. Adjust with set_segment_continuation.
Each segment's segment_assets also lists its overlays (asset_type
ui_element, text under config.overlay) — the one call that audits every
lower third / title card in the project.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum segments to return; 0 returns all. Long-form projects can hold 100+ segments — page with offset/limit instead of pulling everything at once.
offsetNo0-based index of the first segment to return (pagination)
project_idYesProject ID, as returned by create_project or list_projects

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / limit
      Added value: +{
      +  "default": 0,
      +  "description": "Maximum segments to return; 0 returns all. Long-form projects can hold 100+ segments — page with offset/limit instead of pulling everything at once.",
      +  "title": "Limit",
      +  "type": "integer"
      +}
    • addedInput schema / properties / offset
      Added value: +{
      +  "default": 0,
      +  "description": "0-based index of the first segment to return (pagination)",
      +  "title": "Offset",
      +  "type": "integer"
      +}
  2. Changed1 schema field changed
    • addedInput schema / properties / project_id / description
      Added value: +"Project ID, as returned by create_project or list_projects"
  3. First observed

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare readOnlyHint, idempotentHint, and destructiveHint, so safety is covered. The description adds substantial behavioral context: it explains the meaning of the `continues_from_segment` field (continuation vs. fresh shot), the pagination behavior (limit/offset, 0 returns all), and that each segment's assets include overlays. It also discloses the return shape {total, offset, returned, segments}. No contradictions with annotations.

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?

The description is longer than typical but every sentence contributes: it covers the return shape, pagination, the continuation semantics, and the overlay auditing capability. It is front-loaded with the core purpose, and the subsequent paragraphs expand on important behavioral details without redundancy. It earns its length given the tool's complexity.

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 read-only listing tool with three parameters, no output schema, and rich annotations, the description covers everything an agent needs: the return structure, the pagination pattern, the special meaning of a field, and how the result relates to other tools. The description is complete enough to call the tool correctly without additional context.

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 100%, so the parameters are already described. The description goes beyond the schema by explaining the pagination intent ('page through with offset/limit rather than fetching all segments') and clarifying that segment_number (not a parameter here) is the handle for other tools. It reinforces the meaning of limit/offset without repeating the schema text verbatim, adding contextual value.

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?

The description opens with a specific verb ('List') and resource ('storyboard's segments'), then enumerates the returned fields (narration span, type, duration, creative direction). It explicitly states that segment_number is the handle used by all segment tools, and distinguishes itself from sibling tools like get_segment_assets by noting it is the one call that audits every overlay. This clearly separates it from the get_segment_assets sibling.

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?

The description gives explicit guidance on when to use this tool: to list segments and to audit overlays, and it tells the agent to page through large projects with offset/limit rather than fetching everything. It also points to set_segment_continuation for adjusting the continuation field, giving an alternative action. No ambiguity about when to use it versus other list tools.

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