Skip to main content
Glama
theloniuser

InDesign UXP MCP Server

by theloniuser

preflight_document

Preflight the document to detect errors and warnings using a selected profile. Optionally include warnings in the report.

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?

No annotations provided, so the description must convey behavioral traits. It only says 'Run preflight' without stating side effects, output format, or whether the operation is read-only or modifies the document.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is extremely concise (5 words), but it omits important context. It earns its place but is under-informative for a tool with 2 parameters.

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 does not explain what 'preflight' entails, return values, or the purpose of parameters. Given no output schema and no annotations, the description is incomplete.

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% with descriptions for both parameters, so the description adds no additional meaning. Baseline score of 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description 'Run preflight on the document' clearly states the action and resource (preflight on document), but does not differentiate from similar sibling tools like 'preflight_book' or 'validate_document'.

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 on when to use this tool versus alternatives such as 'validate_document' or 'cleanup_document'. No context on prerequisites or conditions.

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