Skip to main content
Glama

Validate guide

validate_guide
Read-onlyIdempotent

Check a guide before saving it: unknown [DIRECTIVES], undefined {VARIABLES}, secrets typed literally, steps that cannot execute, missing "Go to" start, length versus the 5-minute cap. Returns problems with line numbers, an estimated video length and an estimated credit cost. Costs nothing.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindYesauth = login steps; main = the walkthrough that becomes the video.
deviceNoCheck for a phone or tablet run (a preset such as iphone or ipad): warns about hover steps and large zooms. Default: the project's device.
contentYesThe guide text to check, one step per line.
project_idNoWhen given, {VARIABLES} are checked against the project and a credit estimate is returned.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
passedYestrue when there are no problems; warnings alone do not fail a guide.
problemsYesMust be fixed before put_guide.
warningsYesWorth fixing; the guide still records.
action_stepsYesSteps the browser performs (directive-only lines excluded).
estimated_lengthYesRough video length, e.g. "2:10".
estimated_creditsNoPresent for main guides when project_id is given.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already declare readOnlyHint and idempotentHint, and the description adds significant context: it costs nothing, returns problems with line numbers, estimated video length, and credit cost. It also details the checks performed. No contradiction with annotations; adds substantial behavioral disclosure.

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 description is a single paragraph with two sentences. It front-loads the purpose ('Check a guide before saving it') and packs the checks into a list. It's moderately concise but not overly verbose; every clause earns its place. Slightly longer than necessary but well structured.

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?

Given the tool's complexity, the existing output schema (which likely describes the returned problems and estimates), and the read-only annotations, the description covers all essential behavior: checks performed, return types (line numbers, length, cost), and the cost-free nature. Nothing an agent needs to invoke it correctly is missing.

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 four parameters. The description adds no parameter-specific meaning beyond what's in the schema; it discusses content checks but doesn't elaborate on how parameters influence behavior. Baseline 3 is appropriate.

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?

The description states a specific verb ('Check') and resource ('a guide'), and enumerates the exact validation checks (unknown DIRECTIVES, undefined VARIABLES, secrets, step executability, missing start, length cap). It clearly distinguishes from siblings like put_guide by positioning itself as a pre-save validation step.

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?

The phrase 'before saving it' gives a clear temporal context for when to use the tool. It implicitly contrasts with put_guide, but doesn't explicitly name alternatives or state when not to use it. The guidance is clear enough for an agent to infer the intended workflow.

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.