Skip to main content
Glama

Validate project

project_validate
Read-onlyIdempotent

Check an IlluGen project for offline issues like unknown nodes, dangling links, or missing export nodes before rendering. Optionally run engine checks to detect dropped nodes and serialization errors.

Instructions

Checks a project for problems before rendering it.

Offline checks: unknown node types, unknown parameters, dangling links, missing export node. `legacy_params`
(informational) lists parameters of older project versions, such as the shipped presets, that IlluGen renames
or ignores on load. With engine=true, it also loads and re-saves a temporary copy in an invisible IlluGen,
runs a trial export, and reports what the real loader dropped (nodes, links), serialization errors from its log
and a screenshot of any load-issue dialog. The project file is never modified.
Returns: a report {ok, offline_issues, legacy_params, and with engine: dropped_nodes, dropped_links,
trial_export, engine_log_issues, load_dialog} followed by any screenshots.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pathYesAbsolute path of the .illugen project file.
engineNoAlso check the project in the real IlluGen (slower, needs IlluGen installed). Default false: offline checks only.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.1.2
    • addedInput schema / properties / engine / description
      Added value: +"Also check the project in the real IlluGen (slower, needs IlluGen installed). Default false: offline checks only."
    • addedInput schema / properties / path / description
      Added value: +"Absolute path of the .illugen project file."
  2. First observedv0.1.0

TDQS

A4.7/5.0
Behavior5/5

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

The annotations already declare readOnlyHint/idempotentHint/destructiveHint=false, and the description reinforces this with an explicit 'The project file is never modified' plus the detail that the engine path works on a temporary copy in an invisible IlluGen instance. It also discloses the real cost and prerequisite of engine=true (slower, needs IlluGen installed) and enumerates what each mode surfaces, which goes well beyond the 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?

Front-loaded with the one-sentence purpose, then cleanly sections offline checks, engine checks, the non-mutation guarantee, and the return shape. Dense but every clause carries information an agent needs; nothing is 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?

There is no output schema, but the description compensates by spelling out the complete report structure ({ok, offline_issues, legacy_params} plus engine fields and screenshots). For a two-parameter tool with strong annotations, this is fully self-contained.

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%, so the baseline is 3, but the description earns extra credit by explaining what engine=true actually does internally (load, re-save copy, trial export, log issues, load dialog screenshot) and clarifying that legacy_params is informational. It adds real semantic depth beyond the one-line schema descriptions.

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+resource ('Checks a project for problems') and adds the crucial framing 'before rendering it', which distinguishes it from siblings like project_normalize, project_render, and project_summary. An agent can tell exactly what this tool is for without opening the schema.

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?

Gives clear context ('before rendering it') and, more usefully, explains the two operating modes and when to choose each: offline-only by default, or engine=true for the slower real-IlluGen check that requires IlluGen installed. It does not explicitly name sibling alternatives (e.g. project_normalize) as the tool to use instead, so it stops short of full routing guidance.

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