Skip to main content
Glama

Start walkthrough

start_walkthrough

Begin a narrated slide walkthrough from a title and opening line, and get a playable link right away so viewers watch while you add the remaining slides.

Instructions

Create a narrated walkthrough. Pass its opening in opening: the reply then comes once that is voiced, with the handle, the playable link and the full authoring guide. Send the link to the user at once, in a message, before your next tool call; they watch while you add the body with add_slides. Without opening, the reply is short and your first add_slides call must carry the opening instead.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
frameNoSlide shape: landscape (default, 1280×720), square (960×960) or portrait (720×1280, for phones).landscape
speedNoSpeech rate from 0.8 to 1.3; 1.0 is normal.
titleYesWalkthrough title, shown on the title slide and in the player.
voiceNoEnglish Kokoro voice id. Omit for the default. Voices: af_heart, af_bella, af_nicole, af_aoede, af_kore, af_sarah, af_nova, af_sky, af_alloy, af_jessica, af_river, am_michael, am_fenrir, am_puck, am_echo, am_eric, am_liam, am_onyx, am_adam, bf_emma, bf_isabella, bf_alice, bf_lily, bm_george, bm_fable, bm_lewis, bm_daniel.
openingNoThe opening in Markdown, voiced before this call returns: a `#` title heading, an optional `>` subtitle line, then one or two short spoken sentences as a plain paragraph. Nothing more; the body goes in add_slides. Example: # How the retry loop works > Backoff in the HTTP client A failed request can be sent up to four times. We'll follow one through the client.
project_dirNoAbsolute path of the project. Code blocks with file= and image paths are read from it and must stay inside it. Defaults to the client's root, then the server's working directory.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.8/5.0
Behavior5/5

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

Annotations declare the mutation profile (readOnly=false, destructive=false, idempotent=false) but say nothing about blocking semantics or output. The description adds the critical behavior that the call blocks until the opening is voiced and returns a handle, a playable link, and an authoring guide — exactly the context annotations cannot provide.

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?

Dense but front-loaded: the core action leads, then the sequencing and the opening/no-opening branch. Every sentence carries operational weight, though the second sentence is long and packs the reply-contents, the immediate-link instruction, and the body-authoring step into one breath.

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?

With no output schema, the description carries the full burden of describing what comes back (handle, playable link, authoring guide) and does so, plus it defines the two response shapes conditioned on `opening`. Nothing an agent needs to invoke and follow up correctly is missing.

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 description coverage is 100%, so the baseline is 3, but the description adds value by explaining the consequence of supplying versus omitting `opening` (the reply shape and where the opening must then go). That is meaningful semantics beyond the schema's format-and-example text, though it stops short of covering the other five parameters.

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 and resource ('Create a narrated walkthrough') and immediately grounds it against the sibling workflow ('add the body with add_slides'). An agent can distinguish this from add_slides, revise_slide, and finish_walkthrough without opening any 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?

Gives explicit sequencing instructions (send the link at once, in a message, before the next tool call) and branches on the `opening` parameter: with it, the reply is short; without it, the first add_slides call must carry the opening. This is clear when-and-how guidance tied to the sibling tool.

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