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 and a corrected example for each, and an estimated video length. Costs nothing. Call get_guide_instructions before writing a guide.

Input 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.

Output Schema

NameRequiredDescriptionDefault
helpNoWhere to read the rules, when there are problems.
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".

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedOutput schema / properties / help
      Added value: +{
      +  "description": "Where to read the rules, when there are problems.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / problems / items / properties / fix
      Added value: +{
      +  "description": "A corrected example, when one applies.",
      +  "type": "string"
      +}
    • addedOutput schema / properties / problems / items / properties / message / description
      Added value: +"The rule this line breaks."
  2. Changed2 schema fields changed
    • changedInput schema / properties / project_id / description
      Previous value: -"When given, {VARIABLES} are checked against the project and a credit estimate is returned."New value: +"When given, {VARIABLES} are checked against the project."
    • removedOutput schema / properties / estimated_credits
      Removed value: -{
      -  "description": "Present for main guides when project_id is given.",
      -  "type": [
      -    "number",
      -    "null"
      -  ]
      -}
  3. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, and non-open-world, so safety is covered; the description adds genuinely new facts: the check costs nothing (relevant given get_credits/top_up siblings) and the response shape is problems with line numbers plus a corrected example and estimated video length. It stops short of detailing how many problems are returned or whether checks are fatal vs advisory.

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-loaded with the core action and a compact list of checks, then response shape, then cost, then the prerequisite call. Dense but every clause carries information; the 'Costs nothing.' fragment is terse but earns its place.

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?

With a full input schema and an output schema present, the description only needs to convey the checks performed and the workflow position, both of which it does. Minor remaining gap is guidance on whether a failing guide blocks saving or how to act on reported problems.

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 each parameter is already explained in the schema. The description only implies the role of `kind`/length via the 5-minute cap and does not add syntax or format detail beyond the schema's own text, so the baseline of 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 and resource ('Check a guide before saving it') and then enumerates exactly what is checked: unknown [DIRECTIVES], undefined {VARIABLES}, literal secrets, non-executable steps, missing "Go to" start, and length versus the 5-minute cap. This clearly separates it from put_guide (which saves) and get_guide (which retrieves) among the siblings.

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?

Positions usage unambiguously in the workflow: run before saving, and call get_guide_instructions before writing a guide. It names the prerequisite sibling but does not state any exclusion or failure case where validation should be skipped.

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.