Skip to main content
Glama

Validate a storyboard

validate_storyboard
Read-only

Validate a storyboard against the engine schema by providing a directory, file path, or JSON string. Use relaxed mode to make narration optional.

Instructions

Validate a storyboard against the engine schema without running anything. Pass exactly one of: dir (uses generated/storyboard.json), path (a storyboard file), or json (storyboard JSON as a string). relaxed makes narration optional (probe semantics).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dirNodemo dir → generated/storyboard.json
jsonNostoryboard JSON as a string
pathNopath to a storyboard .json file
paramsNostoryboard template params (name → value); each must be declared in the storyboard's params block. Substitutes {{name}} across all stages.
relaxedNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
lintNo
titleNo
validYes
issuesYes
warningsYes
sceneCountNo
storyboardPathNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.14.1
    • addedOutput schema / properties / lint
      Added value: +{
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "action": {
      +        "type": "number"
      +      },
      +      "code": {
      +        "type": "string"
      +      },
      +      "fix": {
      +        "type": "string"
      +      },
      +      "message": {
      +        "type": "string"
      +      },
      +      "scene": {
      +        "type": "string"
      +      },
      +      "severity": {
      +        "enum": [
      +          "error",
      +          "warn",
      +          "info"
      +        ],
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "severity",
      +      "code",
      +      "message"
      +    ],
      +    "type": "object"
      +  },
      +  "type": "array"
      +}
  2. First observedv0.9.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, and the description adds the non-execution behavior ('without running anything') and the relaxed-mode semantics ('makes narration optional (probe semantics)'). It does not describe return values, but the output schema exists to cover that, and there is no contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences with no filler. The core purpose is front-loaded, and the parameter guidance is compact and immediately actionable.

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?

For a read-only validation tool with an output schema, the description covers the essential input-mode selection and the only ambiguous flag. The term 'probe semantics' is somewhat jargon-heavy and could be clearer about the relationship to the sibling probe tool, but overall an agent has enough information to call the tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Although schema description coverage is 80%, the description adds crucial information absent from the schema: the mutual-exclusion rule ('exactly one of: dir, path, json') and the meaning of relaxed ('narration optional / probe semantics'), which the schema leaves undescribed. This goes well beyond the baseline and materially helps an agent invoke the tool correctly.

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 action ('Validate a storyboard') against a specific resource ('the engine schema') and adds the key qualifier 'without running anything', which distinguishes it from execution-oriented tools like render or probe. It clearly differentiates from sibling tools like lint_storyboard by focusing on schema validation rather than style/lint checking.

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 description gives explicit selection guidance for input modes: 'Pass exactly one of: dir, path, or json', which is critical for correct invocation. It provides clear context for when to use the tool (validation without execution) but does not explicitly name alternatives like lint_storyboard or state when relaxed mode should be chosen over strict mode.

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