Skip to main content
Glama

Read the film

read_film
Read-onlyIdempotent

Read main.film, the document that is the project, or with path another film file of the project (a module it imports, such as brand.film; list_files lists them). Required nullable offset (1-indexed start line) and limit return a line window. Line numbers are a map; do not copy them into patch_film find. Use this before patch_film. Does not list uploaded assets or TypeScript components. When an effect in the film still waits for something (its person mask being made, a face, a photo), the answer ends with Effects waiting: what each one needs and the call that settles it, most often prepare_effect. When the film has events (an on a clip, a key's event, or one a component emits from its code with useCues().emit), the answer lists them under Events in film seconds, each with the at that keeps a sound clip on it.

Input Schema

NameRequiredDescriptionDefault
pathYesThe film file: null for main.film, or a module file name such as "brand.film" (letters, digits, - and _ before .film, no folders). list_files lists them.
limitYesNumber of lines to return. Pass null to read through the cap.
offsetYes1-indexed start line. Pass null with limit to read from the start.
projectIdYesThe project this call runs on without changing the open project. null (or leaving it out) uses the open project. wait_for_jobs takes the projectId of the calls that started the jobs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / path
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "The film file: null for main.film, or a module file name such as \"brand.film\" (letters, digits, - and _ before .film, no folders). list_files lists them."
      +}
    • changedInput schema / required
      Previous value: -[
      -  "offset",
      -  "limit",
      -  "projectId"
      -]New value: +[
      +  "offset",
      +  "limit",
      +  "path",
      +  "projectId"
      +]
  2. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already establish read-only, idempotent, non-destructive behavior. The description adds valuable conditional output details: the answer may end with 'Effects waiting' and may list events in film seconds with their at values, which goes beyond the 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 core purpose is front-loaded and the conditional output details are useful, but the final two sentences are long and dense. The description is appropriately sized for a tool with complex response behavior, though it could be more scannable.

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?

Covers reading the main film and module files, line-window behavior, and special response sections for waiting effects and events. With no output schema, it provides enough return-value context for an agent to call the tool correctly, though general error/edge-case behavior is not described.

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 description coverage is 100%, so parameter documentation is already complete. The description restates the offset/limit line-window behavior and path meaning, but does not add substantive parameter semantics beyond the schema.

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?

Starts with a specific verb and resource: 'Read main.film, the document that is the project.' It also explains the alternative path case for module files and distinguishes the tool from list_files and patch_film.

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 clear workflow guidance ('Use this before patch_film') and a warning about not copying line numbers into patch_film. It also states what the tool does not list (uploaded assets or TypeScript components), though it does not explicitly name read_component as the alternative.

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.