Skip to main content
Glama

Get the storyboard JSON Schema

get_storyboard_schema
Read-only

Retrieves the exact JSON Schema for storyboard.json, generated from the engine's Zod schema, so you can validate or author files against the contract the engine enforces.

Instructions

JSON Schema for storyboard.json, generated from the engine's own zod schema — the exact contract the engine validates against.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_storyboard_schema"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
schemaYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.20.2
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • addedOutput schema / properties / schema / propertyNames
      Added value: +{
      +  "type": "string"
      +}
  2. First observedv0.9.0

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so safety is covered. The description adds real context beyond that: the schema is machine-generated from the engine's own zod definition and is the exact contract the engine validates against, which tells the agent to trust it over prose docs. It does not say anything about output shape or versioning, but the output schema covers the return value.

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?

A single sentence, front-loaded with what it returns, followed by the provenance qualifier that justifies trusting it. No filler and nothing restated from the name or title.

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 zero-parameter getter with an output schema and read-only annotation, the description supplies the one thing structured fields cannot: where the schema comes from and how authoritative it is. Adding one clause about pairing it with validate_storyboard or get_authoring_guide would make it fully complete.

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?

The tool takes zero parameters, so there is nothing for the description to disambiguate and the baseline is 4. The empty input schema is consistent with the described behavior.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Names a specific resource (storyboard.json) and states exactly what is returned: its JSON Schema, generated from the engine's zod schema. An agent can tell this apart from validate_storyboard and lint_storyboard, which check a file rather than describe its contract. It stops short of an explicit verb like 'returns', but the intent is unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied: an agent can infer it should call this before writing or repairing storyboard.json. There is no explicit when/when-not, and no routing to obvious complements such as get_authoring_guide (human-oriented guidance) or validate_storyboard (checking an existing file).

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