Skip to main content
Glama
theloniuser

InDesign UXP MCP Server

by theloniuser

preflight_book

Run a preflight check on a book to detect potential problems, and optionally save the report to a file or open it automatically.

Instructions

Preflight a book and optionally save the report

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
bookPathYesPath to the book file
outputPathNoPath for the preflight report (optional)
autoOpenNoAutomatically open the report
Behavior2/5

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

With no annotations, the description carries full burden but only states the basic action. It does not disclose side effects, permissions, report contents, or whether the operation is read-only.

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?

The description is a single concise sentence. While not overly detailed, it is front-loaded and efficient with no wasted words.

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 description omits return value information and does not explain the nature of a preflight report. For a tool with 3 parameters and no output schema, more detail is needed for complete understanding.

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?

All parameters have schema descriptions (100% coverage), so the description adds only marginal context ('optionally save'). Baseline 3 is appropriate.

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 tool's action ('preflight a book') and optional output ('save the report'), distinguishing it from the sibling 'preflight_document' which operates on single documents.

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?

The description implies usage for book files, but provides no explicit guidance on when to use this tool versus alternatives like 'preflight_document' or other analysis tools.

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/theloniuser/indesign-uxp-server'

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