get_segments
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. Each segment also reports continues_from_segment. When set, this shot is a...
This record as markdown: /tools/com-framesail-framesail/get-segments.md
What get_segments does on Framesail
AI agents call get_segments to retrieve information from Framesail without modifying anything. It is typically the context-gathering step in research, monitoring, and reporting workflows, before the agent takes action elsewhere.
| Parameter | Type | Required | Description |
|---|---|---|---|
project_id | string | Yes | Project ID, as returned by create_project or list_projects |
Parameters from the server's own tool schema.
Why get_segments is rated Low
This tool performs a read-only query operation that retrieves and lists existing storyboard segment data without any side effects, modifications, or triggering external processes. It is a straightforward data retrieval function used to inspect the current state of a video project's storyboard.
From the tool's definition Tool name is 'get_segments' and description explicitly states 'List the storyboard's segments', with no mention of modifications, deletions, or execution of operations.
Risk signalsBulk/mass operation — affects multiple targets
Attacks that exploit this kind of access
The rule that runs get_segments safely
PolicyLayer is an MCP gateway: it sits between your AI agents and Framesail, and checks every tool call against a rule you set before the call runs. Nothing changes on the server itself. For get_segments, this is the rule to start with:
get_segments is read-only, so it stays allowed. Everything else on the server is denied unless you say otherwise.
The button opens the PolicyLayer dashboard: create your workspace, connect Framesail, apply this rule, and every get_segments call is checked against it from then on.
Questions about get_segments
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. Each segment also reports continues_from_segment. When set, this shot is a CONTINUATION of that earlier segment: its rendered frame carries over (same composition, characters, and setting) and only the delta changes — an added overlay, a shifted expression, a closer angle, a slow reframe. Null means a fresh, independent shot. The storyboard plans these chains automatically; adjust them with set_segment_continuation. It is categorised as a Read tool in the Framesail MCP Server, which means it retrieves data without modifying state.
get_segments accepts 1 parameter: project_id. Required: project_id. The full parameter table on this page comes from the server's own tool schema.
Register the Framesail MCP server in PolicyLayer and add a rule for get_segments: allow, deny, rate-limit, or require approval. Point your MCP client at the PolicyLayer proxy URL and the rule is enforced on every call, before it reaches Framesail. Nothing to install.
get_segments is a Read tool with low risk. Read-only tools are generally safe to allow by default.
Yes. Add a rate_limit block to the get_segments rule in your PolicyLayer policy. For example, setting max: 10 and window: 60 limits the tool to 10 calls per minute. Rate limits are tracked per agent session and reset automatically.
Set action: deny in the PolicyLayer policy for get_segments. The AI agent will receive a policy violation error and cannot call the tool. You can also include a reason field to explain why the tool is blocked.
get_segments is provided by the Framesail MCP server (https://api.framesail.com/mcp). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.
More on Framesail, and thousands of servers like it.
This server
Across the catalogue