Skip to main content
Glama

Validate project JSON

validate_project_json

Validate a Zvid project payload for errors and layout warnings before rendering. Optionally run server-side validation against your plan limits.

Instructions

Validate a Zvid project payload BEFORE rendering (free, no credits). Returns { valid, errors: [{field, message}], warnings }. Warnings include LAYOUT LINT — overlapping texts, x/y ignored by position presets, boxes extending off-canvas, padding that will get cut off, low text contrast — treat every layout warning as a fix-before-render item. Local validation mirrors the backend rules; set remote: true to ALSO run the payload through the live API validator (POST /api/render/validate/api-key — resolves templates and applies your plan's real limits).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kindNoValidate as a bare "project" payload (default) or as a full "render-request" body
remoteNoAlso validate server-side against your account's actual plan limits (default true; set false only for offline diagnostics)
payloadYesThe project JSON to validate (the `payload` you would pass to create_render)
Behavior5/5

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

No annotations provided, but description fully discloses behavior: returns valid, errors, warnings; details lint checks; explains local vs remote validation. No contradictions.

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?

Description is information-dense but efficient. Starts with main action, then return structure, then warnings detail, then remote option. No filler.

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, description adequately explains return shape and provides example warning types. Covers all 3 parameters and required field. Suitable for validation tool.

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 coverage is 100%, but description adds value: explains kind enum (project vs render-request), remote default behavior and when to set false, and payload usage. Minor overlap with schema.

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?

Description uses specific verb 'validate', names resource 'Zvid project payload', clarifies 'before rendering', and distinguishes from other tools by noting it's free and no credits. Return format is clearly stated.

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?

Explicitly states when to use (before rendering) and explains remote vs local validation with concrete use cases. Does not list sibling tools, but the context is clear.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Zvid-io/zvid-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server