Skip to main content
Glama

Record screen

record_screen

Records the product on a mock (Code record) as a screen-recording clip in a project. Creates blank placeholder clips, registers job entities, and sends the job to AVS.

The blank clips this tool creates are placeholders; they become video clips when processing completes, so removing one loses that scene. Article placeholders are also inserted automatically into plainDoc.

Check how the recording is going with get_recording_activity(project_id). A recording can take hours, so check once rather than polling in a loop.

Requires the Auto-Recording add-on and per-workspace sign-in credentials for the product being recorded. Workspaces without it get back the manual path instead (upload_file, then add_clips(kind='video')) rather than a failure.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
scenesYesREQUIRED — the recording to make, as a list of scenes. This is the ONLY way to specify what to record. A normal single recording is exactly ONE scene; a code-wizard multi-scene / marketing video is N scenes (one clip per scene, and ALL cuts of one video go in a SINGLE record_screen call). A narrated scene REQUIRES a non-empty narration_script; a b-roll scene is silent (no narration, no article). A cut that starts somewhere disconnected is just a scene with entry.mode "fresh". Cleopatra orgs accept exactly ONE narrated scene. Do not set scene_id — it is assigned server-side.
targetNoWhich recorder to use when the workspace has both Code record and Browser record: 'code' for a mock of the product, 'browser' for the real product — from the user's request, or their answer when it didn't say. Omit otherwise.
chat_idYesConversation context ID
guide_idYesTarget guide ID
languageNoLanguage code for the recording (default: en)en
clueprint_idNoThe clueprint this video is built from, if any (the id you passed to get_clueprint). Effects placed automatically on the recording follow that clueprint's effect rules; omit it and they follow the default rules.
voice_versionNoElevenLabs voice generation for every scene's voice. Leave unset: a named voice uses latest and the workspace default keeps its own saved version. Use 'legacy' ONLY when the user explicitly asks for the legacy/older voice generation; never choose it yourself.
edit_scene_idsNoThe clip id(s) this edit replaces. Only used when recording_session_id is set; scenes you do not name are not re-filmed. Set preceding_clip_id to the clip you are replacing — an edit naming a clip that is not in the guide is refused rather than appended to the end.
video_intentionNoOne-line intent shared across all scenes of a multi-scene recording (e.g. "punchy 30s launch teaser for feature X"). Ignored for single-scene recordings.
preceding_clip_idYesClip ID after which to insert the new clip
video_script_modeNoHow the narration is treated. 'exact': the user's narration is final and is read word for word; steps the script does not mention play silently. 'near_exact': keep the user's narration word for word, but briefly narrate steps the recording must take that the script does not mention (for example opening a settings dialog to reach something) — use this when the user gives a finished script and did not ask for strictly exact wording. 'rewrite': the narration is a draft and may be reworded to match what was recorded — use this when there is no user script or it is rough. Overrides exact_video_script when both are set.
exact_video_scriptNoLegacy flag — prefer video_script_mode instead. Set to true when the video narration must be used exactly as written — the agent that does the recording will not reword, rephrase, or rewrite video_script at all. Default false.
article_script_modeNo'exact': the article is used word for word. 'rewrite': the article may be reworded to match the recording. Overrides exact_article_script when both are set.
custom_instructionsNoOptional per-recording instructions (e.g. "select project X", "add rectangle 200x100"). Not related to mocking.
exact_article_scriptNoLegacy flag — prefer article_script_mode instead. Set to true when the article must be used exactly as written — the agent that does the recording will not reword, rephrase, or rewrite article_script at all. Default false.
recording_session_idNoEDIT an existing recording instead of shooting a new one. Pass the recording_session_id from the record_screen that made it, or read it off get_clip. The recorder restores that take's code, notes and click script and changes only what you ask for, which is far faster and cheaper than re-recording. Omit for a fresh recording. Only code-wizard recordings are editable; get_clip omits the field for any clip that is not.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / clueprint_id
      Added value: +{
      +  "description": "The clueprint this video is built from, if any (the id you passed to get_clueprint). Effects placed automatically on the recording follow that clueprint's effect rules; omit it and they follow the default rules.",
      +  "type": "string"
      +}
  2. Changed1 schema field changed
    • addedInput schema / properties / voice_version
      Added value: +{
      +  "description": "ElevenLabs voice generation for every scene's voice. Leave unset: a named voice uses latest and the workspace default keeps its own saved version. Use 'legacy' ONLY when the user explicitly asks for the legacy/older voice generation; never choose it yourself.",
      +  "enum": [
      +    "latest",
      +    "legacy"
      +  ],
      +  "type": "string"
      +}
  3. Changed1 schema field changed
    • addedInput schema / properties / target
      Added value: +{
      +  "description": "Which recorder to use when the workspace has both Code record and Browser record: 'code' for a mock of the product, 'browser' for the real product — from the user's request, or their answer when it didn't say. Omit otherwise.",
      +  "enum": [
      +    "code",
      +    "browser"
      +  ],
      +  "type": "string"
      +}
  4. Changed8 schema fields changed
    • addedInput schema / properties / article_script_mode
      Added value: +{
      +  "description": "'exact': the article is used word for word. 'rewrite': the article may be reworded to match the recording. Overrides exact_article_script when both are set.",
      +  "enum": [
      +    "rewrite",
      +    "exact"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / exact_article_script / description
      Previous value: -"Set to true when the article must be used exactly as written — the agent that does the recording will not reword, rephrase, or rewrite article_script at all. Default false."New value: +"Legacy flag — prefer article_script_mode instead. Set to true when the article must be used exactly as written — the agent that does the recording will not reword, rephrase, or rewrite article_script at all. Default false."
    • changedInput schema / properties / exact_video_script / description
      Previous value: -"Set to true when the video narration must be used exactly as written — the agent that does the recording will not reword, rephrase, or rewrite video_script at all. Default false."New value: +"Legacy flag — prefer video_script_mode instead. Set to true when the video narration must be used exactly as written — the agent that does the recording will not reword, rephrase, or rewrite video_script at all. Default false."
    • addedInput schema / properties / scenes / items / properties / article_script_mode
      Added value: +{
      +  "description": "How the article is treated for this scene. Overrides the top-level setting for this scene.",
      +  "enum": [
      +    "rewrite",
      +    "exact"
      +  ],
      +  "type": "string"
      +}
    • changedInput schema / properties / scenes / items / properties / exact_article_script / description
      Previous value: -"When true, article_script for this scene is used verbatim and left unreworded. Overrides the top-level setting for this scene."New value: +"Legacy flag — prefer article_script_mode instead. When true, article_script for this scene is used verbatim and left unreworded. Overrides the top-level setting for this scene."
    • changedInput schema / properties / scenes / items / properties / exact_video_script / description
      Previous value: -"When true, narration_script for this scene is used verbatim and left unreworded. Overrides the top-level setting for this scene."New value: +"Legacy flag — prefer video_script_mode instead. When true, narration_script for this scene is used verbatim and left unreworded. Overrides the top-level setting for this scene."
    • addedInput schema / properties / scenes / items / properties / video_script_mode
      Added value: +{
      +  "description": "How the narration is treated for this scene. Overrides the top-level setting for this scene.",
      +  "enum": [
      +    "rewrite",
      +    "near_exact",
      +    "exact"
      +  ],
      +  "type": "string"
      +}
    • addedInput schema / properties / video_script_mode
      Added value: +{
      +  "description": "How the narration is treated. 'exact': the user's narration is final and is read word for word; steps the script does not mention play silently. 'near_exact': keep the user's narration word for word, but briefly narrate steps the recording must take that the script does not mention (for example opening a settings dialog to reach something) — use this when the user gives a finished script and did not ask for strictly exact wording. 'rewrite': the narration is a draft and may be reworded to match what was recorded — use this when there is no user script or it is rough. Overrides exact_video_script when both are set.",
      +  "enum": [
      +    "rewrite",
      +    "near_exact",
      +    "exact"
      +  ],
      +  "type": "string"
      +}
  5. Changed4 schema fields changed
    • removedInput schema / properties / context
      Removed value: -{
      -  "description": "Explain in 15-25 words, in third person, why this tool is called and how it supports the user's goal. For analytics only. You MUST describe only the abstract purpose of the tool call. NEVER include, repeat, paraphrase, or infer personal, sensitive, or identifying information from the user request or tool results, including names, emails, phone numbers, IPs, IDs, or credentials. You MUST generalize specific entities into roles such as \"a user\", \"the customer\", or \"an account\". Example: \"Retrieving a customer's recent orders to investigate a billing issue and help support determine the appropriate resolution.\"",
      -  "type": "string"
      -}
    • removedInput schema / properties / conversation_id
      Removed value: -{
      -  "description": "Echo the conversation_id from the server's previous response. The server provides it on the first call — never invent one, and do not issue parallel tool calls until you have it.",
      -  "type": "string"
      -}
    • removedInput schema / properties / llm_model
      Removed value: -{
      -  "description": "The exact model identifier you (the assistant) are running as, taken from your system prompt or environment (e.g. \"claude-opus-4-8\", \"gpt-5.2\"). Used for analytics only. If you do not know your model identifier with certainty, pass \"unknown\" — never guess.",
      -  "type": "string"
      -}
    • changedInput schema / required
      Previous value: -[
      -  "guide_id",
      -  "chat_id",
      -  "preceding_clip_id",
      -  "scenes",
      -  "context",
      -  "llm_model"
      -]New value: +[
      +  "guide_id",
      +  "chat_id",
      +  "preceding_clip_id",
      +  "scenes"
      +]
  6. Changed4 schema fields changed
    • addedInput schema / properties / context
      Added value: +{
      +  "description": "Explain in 15-25 words, in third person, why this tool is called and how it supports the user's goal. For analytics only. You MUST describe only the abstract purpose of the tool call. NEVER include, repeat, paraphrase, or infer personal, sensitive, or identifying information from the user request or tool results, including names, emails, phone numbers, IPs, IDs, or credentials. You MUST generalize specific entities into roles such as \"a user\", \"the customer\", or \"an account\". Example: \"Retrieving a customer's recent orders to investigate a billing issue and help support determine the appropriate resolution.\"",
      +  "type": "string"
      +}
    • addedInput schema / properties / conversation_id
      Added value: +{
      +  "description": "Echo the conversation_id from the server's previous response. The server provides it on the first call — never invent one, and do not issue parallel tool calls until you have it.",
      +  "type": "string"
      +}
    • addedInput schema / properties / llm_model
      Added value: +{
      +  "description": "The exact model identifier you (the assistant) are running as, taken from your system prompt or environment (e.g. \"claude-opus-4-8\", \"gpt-5.2\"). Used for analytics only. If you do not know your model identifier with certainty, pass \"unknown\" — never guess.",
      +  "type": "string"
      +}
    • changedInput schema / required
      Previous value: -[
      -  "guide_id",
      -  "chat_id",
      -  "preceding_clip_id",
      -  "scenes"
      -]New value: +[
      +  "guide_id",
      +  "chat_id",
      +  "preceding_clip_id",
      +  "scenes",
      +  "context",
      +  "llm_model"
      +]
  7. Changed5 schema fields changed
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • removedInput schema / additionalProperties
      Removed value: -false
    • removedInput schema / properties / scenes / items / additionalProperties
      Removed value: -false
    • removedInput schema / properties / scenes / items / properties / entry / additionalProperties
      Removed value: -false
    • removedInput schema / properties / scenes / items / properties / exit / additionalProperties
      Removed value: -false
  8. Changed2 schema fields changed
    • addedInput schema / properties / edit_scene_ids
      Added value: +{
      +  "description": "The clip id(s) this edit replaces. Only used when recording_session_id is set; scenes you do not name are not re-filmed. Set preceding_clip_id to the clip you are replacing — an edit naming a clip that is not in the guide is refused rather than appended to the end.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedInput schema / properties / recording_session_id
      Added value: +{
      +  "description": "EDIT an existing recording instead of shooting a new one. Pass the recording_session_id from the record_screen that made it, or read it off get_clip. The recorder restores that take's code, notes and click script and changes only what you ask for, which is far faster and cheaper than re-recording. Omit for a fresh recording. Only code-wizard recordings are editable; get_clip omits the field for any clip that is not.",
      +  "type": "string"
      +}
  9. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations only cover safety (readOnlyHint=false, destructiveHint=false, openWorldHint=true); the description adds far more: placeholder clips become video clips on completion so removing one loses a scene, article placeholders auto-insert into plainDoc, jobs are long-running (hours), and the tool requires the Auto-Recording add-on plus per-workspace sign-in credentials. This is rich behavioral context beyond the structured fields.

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-loads the core action and side effects, then progress-checking, then prerequisites/fallback. Every sentence carries useful information, though the paragraph on requirements and fallback could be tightened slightly.

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 16-parameter, non-idempotent, open-world recording tool with no output schema, the description covers side effects, long-running job handling, prerequisites, and the degraded path — enough for an agent to call it correctly and set expectations.

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 the schema already documents all 16 parameters in depth. The description body adds little parameter-level syntax or format detail beyond what the schema provides, so the baseline 3 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+resource ('Records the product on a mock (Code record) as a screen-recording clip in a project') and enumerates the concrete side effects (creates blank placeholder clips, registers job entities, sends to AVS). An agent can distinguish this from upload_file/add_clips siblings without opening the schema.

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?

Explicitly names the alternative path for workspaces lacking the add-on ('upload_file, then add_clips(kind='video')') rather than failing, and names get_recording_activity(project_id) for progress with the constraint 'check once rather than polling in a loop.' When-to-use, when-not, and alternatives are all present.

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.