Skip to main content
Glama

Get Surface Solves

zemax_get_surface_solves

Retrieve solve, pickup, and variable states for all properties on a given surface in Ansys Zemax OpticStudio to inspect or debug optical surface settings.

Instructions

Get solve, pickup, and variable states for all surface properties.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
surfaceNumberYesSurface number

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?

No annotations are provided, so the description carries the full behavioral burden. 'Get' implies a read-only operation, but the description does not disclose return format, error conditions, whether the surface must exist, or any other behavioral trait beyond the basic retrieval intent.

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 getter tool.

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?

There is no output schema and no annotations, so the description should ideally say more about what is returned or how the surface solve states are structured. The input is fully covered by the schema, but the lack of return-shape information leaves a noticeable gap.

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 description coverage is 100%, so the schema already documents the single parameter ('surfaceNumber': 'Surface number'). The description adds no parameter meaning beyond that baseline, which is acceptable when the schema fully covers the input.

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 ('Get') and resource ('solve, pickup, and variable states for all surface properties'), so the agent knows this is a retrieval tool for surface solve data. It does not explicitly distinguish itself from sibling tools like zemax_get_surface or zemax_get_variables, but the resource is concrete enough to be understood.

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 when-to-use guidance is provided. The description does not say when to choose this tool over zemax_get_surface, zemax_get_variables, or other related getters, nor does it state any prerequisites or exclusions.

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