Skip to main content
Glama
kakalition

apollo-pdf-creator

by kakalition

validate_spec

Validate a JSON document spec without rendering, catching errors early. In strict mode, also resolve the spec via the engine to get flowable counts and warnings, ensuring spec integrity before PDF generation.

Instructions

Validate a document spec without rendering it.

With strict, also resolve the spec through the engine and report the flowable count and engine warnings. Strict resolution needs reportlab.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
specYes
strictNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it states the tool does not render, explains that strict mode resolves through the engine, reports flowable count and engine warnings, and requires reportlab. This is meaningful behavioral context beyond the bare schema.

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 compact and front-loaded: the core purpose appears in the first line, and the strict-mode behavior is a clean, short addendum. Every sentence earns its place and there is no filler or repetition of schema data.

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?

Given the output schema exists, return-value details do not need to be repeated. The description covers the tool's main behavior, the strict-mode difference, and the reportlab prerequisite. Minor gaps remain, such as what happens if reportlab is absent, but overall an agent has enough to invoke it correctly.

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 0%, so the description must compensate. It adds real semantics to the strict parameter, including what strict resolution does and its dependency. However, it gives no additional detail about the structure or expected shape of the spec object, which is undocumented in the schema as well.

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 names a specific verb ('Validate'), a specific resource ('document spec'), and an explicit exclusion ('without rendering it'). This clearly separates it from the sibling tools create_pdf and from_markdown, so an agent can distinguish it without inspecting their schemas.

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 conveys when to use the tool: to validate a spec rather than render it. It also clarifies the optional strict mode and its dependency on reportlab. However, it does not explicitly name create_pdf or from_markdown as alternatives or state when not to use them, so it misses the top tier of routing guidance.

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

Deploy Server

Other Tools