Skip to main content
Glama

Set Ray Aiming

zemax_set_ray_aiming

Choose Off, Paraxial, or Real ray aiming in Ansys Zemax OpticStudio via MCP to control how rays are targeted during optical simulations.

Instructions

Set ray aiming to Off, Paraxial, or Real.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
rayAimingYesRay-aiming mode

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior2/5

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

With no annotations, the description carries the full burden of behavioral disclosure. It only implies a mutation and lists allowed values, but does not explain what ray aiming does, how modes affect calculations, or whether the change persists.

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, front-loaded sentence with no wasted words. It is appropriately sized for a simple setter tool and directly presents the required information.

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

Completeness3/5

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

For a one-parameter enum tool with full schema coverage and no output schema, the description is minimally adequate to invoke the tool. However, without annotations it omits why or when each mode should be used, leaving a gap in decision-making context.

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?

The schema already documents the single parameter at 100% coverage, including the enum values and a brief description. The description merely restates the enum values, adding no meaning beyond the schema.

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 states a specific verb ('Set') and resource ('ray aiming to Off, Paraxial, or Real'), making the tool's basic function clear. However, it does not differentiate from the sibling zemax_get_ray_aiming, which reads the same setting.

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?

The description gives no guidance on when to use this tool versus alternatives, nor does it explain when each mode is appropriate. There is no mention of prerequisites or the related get tool.

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

Deploy Server

Other Tools