Skip to main content
Glama

walkthrough

Export a scene-by-scene HTML guide, Markdown SOP, PNGs, captions, and JSON manifest from a rendered demo video plus report.json; returns a jobId for status polling.

Instructions

Export output/walkthrough/ from the final video: index.html (one card per scene — payoff frame, title, narration, jump-to-time; ← → keyboard nav), guide.md (README/SOP-ready), per-scene PNGs, SRT/VTT and a JSON manifest. Needs only the rendered video + report.json (no key, no browser). Returns a jobId immediately — poll job_status. Rejects if another job is running.

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": {
      "dir": "<dir>"
    },
    "name": "walkthrough"
  }
}

Input Schema

NameRequiredDescriptionDefault
dirYesdemo project directory — pass an absolute path
outNooutput directory (default <dir>/output/walkthrough)
langNolanguage variant (final-demo.<lang>.mp4)
widthNoframe width in px (default 960)

Output Schema

NameRequiredDescriptionDefault
kindYes
jobIdYes
statusYes
demoDirYesresolved absolute demo directory
logFileYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.20.2
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  2. Addedv0.14.1

TDQS

A4.1/5.0
Behavior4/5

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

With no annotations supplied, the description carries the burden and does well: it discloses the asynchronous contract (immediate jobId, poll job_status), a concurrency constraint (rejects if another job is running), and least-privilege prerequisites (no key, no browser). It omits overwrite/merge behavior for an existing output/walkthrough directory, which matters for a file-emitting tool.

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 output inventory, then the prerequisite, then the async contract — a sensible order. The artifact list is dense but each item earns its place; the only mild cost is that the first sentence is a long comma-separated enumeration.

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?

An output schema exists, so return-value explanation is unnecessary and the description correctly focuses on prerequisites, async behavior, and artifact contents. For a job-emitting tool with no annotations, the remaining gap is what happens to pre-existing files in the output directory.

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 dir, out, lang, and width with defaults. The description adds only indirect meaning (the video lang variant, the layout of the produced artifacts) and does not clarify units or edge cases for width or the relationship between out and the default path.

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 (export) and resource (output/walkthrough artifacts) and enumerates exactly what is produced: index.html, guide.md, per-scene PNGs, SRT/VTT, manifest. This distinguishes it clearly from sibling generators like gif, stills, frames, and render, which an agent could otherwise confuse it with.

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 preconditions ('needs only the rendered video + report.json', 'no key, no browser') and explicitly routes the agent to the sibling job_status for polling after the immediate jobId return. It does not state when to prefer this over alternatives like stills or gif, nor does it list exclusions, so it falls short of a full when/when-not rule set.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.