preview_route

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

With no annotations, the description fully discloses the key behavioral traits: the operation is non-modifying and deterministic, and the optional token is single-use and scoped to a specific candidate, board revision, and path. This is excellent transparency.

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 concise sentences front-load the core action and then add the optional token behavior. Every word earns its place with no redundancy.

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?

Given the poor input schema and no annotations, the description is not complete enough for an agent to construct a valid request. It mentions one optional parameter but omits what data is required in the request object, making usage ambiguous despite the available output schema.

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?

The input schema is a generic 'request' object with no property definitions and 0% coverage, so the description must compensate. It does explain the behavior of one option ('include_apply_token'), but fails to describe other required request fields, leaving the parameter structure largely undefined.

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 uses a specific verb ('Preview') tied to a clear resource ('one deterministic two-pin route candidate') and explicitly notes it does not modify files, distinguishing it from apply_candidate. This makes the tool's purpose unmistakable.

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 clearly implies usage as a safe preview step before applying, and explains the condition for obtaining an apply token. However, it does not explicitly contrast with sibling tools like validate_candidate or compare_candidates, so it stops short of a 5.

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