ping_indesign

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states what is checked (app open, version, active document) but does not describe failure behavior, return values, or whether it is a read-only operation. Some context is added via the timeoutSec parameter mention, but the behavior on unreachable InDesign remains unclear.

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

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

Two sentences, front-loaded with the purpose and immediately followed by a usage directive. No redundant or wasted words, making it highly efficient.

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

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

The tool is simple with one optional parameter and no output schema. The description covers the purpose, what is checked, and when to call it. A minor gap is the lack of return format or failure behavior, but for a health-check tool the description is largely complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and the parameter timeoutSec already includes a description saying 'Optional override; prefer INDESIGN_SCRIPT_TIMEOUT_SEC for the adapter'. The tool description adds no additional parameter semantics, so the baseline of 3 applies.

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

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

The description clearly states the tool checks if Adobe InDesign is reachable, specifying the exact checks (app open, version, active document). It also distinguishes the tool from siblings by explicitly directing 'Call first in a session before scan_document', making its role unambiguous.

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

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

The description provides explicit usage guidance: 'Call first in a session before scan_document'. This names the exact sibling to be used after and establishes the tool as the initial health check. No exclusions are needed for this type of tool.

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