Skip to main content
Glama

Connect

zemax_connect

Connect to Ansys Zemax OpticStudio in standalone or interactive-extension mode to automate optical design and analysis tasks via the ZOS-API.

Instructions

Connect to OpticStudio in standalone or interactive-extension mode.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modeNoConnection modestandalone
instanceIdNoInteractive Extension instance ID

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.9/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 burden of behavioral disclosure. It mentions the modes but does not state whether this must be called before other tools, what happens if a connection already exists, whether the connection persists, or if a disconnect is required afterward.

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 connection tool and immediately communicates the core action.

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?

For a connection tool with no annotations, no output schema, and no usage guidance, the description is too sparse. It omits essential context such as the connection lifecycle, prerequisites for calling other tools, and what the connection enables.

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 both parameters. The description repeats the mode options but adds no extra meaning or syntax beyond what the schema provides, which sets the baseline at 3.

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 clear verb ("Connect") and resource ("OpticStudio"), and specifies the available modes. It is specific enough for an agent to understand the operation, but it does not distinguish itself from siblings like zemax_disconnect or zemax_status beyond the obvious connection semantics.

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, when not to use it, or what prerequisites are needed. It also does not explain which mode to choose in which situation, leaving the agent to infer usage from the tool name alone.

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