Skip to main content
Glama

preflight_document

Run preflight checks on InDesign documents with configurable profiles and warning inclusion to identify issues before output.

Instructions

Run preflight on the document

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
profileNoPreflight profile nameBasic
includeWarningsNoInclude warnings in report
Behavior2/5

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

With no annotations, the description must fully disclose behavioral traits. It only states 'run preflight' without explaining what preflight does, whether it modifies the document, what constitutes a failure, or what output is produced. This is insufficient for an AI agent to predict side effects.

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 a single sentence with no unnecessary words. It is front-loaded and concise.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool likely produces a report or validation result, but no output schema exists and the description does not mention what happens after execution. Given the lack of annotations and the tool's complexity, the description is too sparse to be fully informative.

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 coverage is 100% (both parameters have descriptions). The description adds no extra meaning beyond what the schema provides, so baseline 3 applies. No improvement or degradation.

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 clearly states the action ('run preflight') and the resource ('the document'). It effectively distinguishes from the sibling 'preflight_book' tool, which operates on a book. The verb+resource pattern is specific and unambiguous.

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

Usage Guidelines2/5

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

No guidance is provided on when to use this tool versus alternatives like 'validate_document' or 'preflight_book'. There are no usage conditions, exclusions, or hints about prerequisites, leaving the AI agent to guess.

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/zachshallbetter/indesign-mcp-server'

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