Skip to main content
Glama

Add Material Catalog

zemax_add_material_catalog

Add a material catalog to the current optical system in Zemax OpticStudio. Specify the catalog name without the .agf extension to enable its materials for optical design.

Instructions

Add a material catalog to the current optical system.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
catalogNameYesMaterial catalog name without the .agf extension

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/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 does not state whether the catalog is loaded from disk or generated, whether it requires the file to exist, what happens if the catalog is already added, or what the return is. 'Add' implies mutation, but no side effects or state changes are described.

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, short, front-loaded sentence with no wasted words. It directly states the action and target.

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 mutation tool with no annotations, no output schema, and no described side effects, the description is insufficient. It should explain what adding a catalog entails (e.g., it becomes available for glass selection), whether it modifies the current system, and any prerequisites. As is, it leaves the agent with only the schema and tool name.

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

Parameters4/5

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

Schema description coverage is 100% (the single parameter 'catalogName' is described as 'Material catalog name without the .agf extension'). The description adds no additional parameter information, but with one parameter and full schema coverage, a baseline of 4 is appropriate for zero additional need.

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

Purpose5/5

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

The description states a specific verb+resource: 'Add a material catalog to the current optical system.' This is precise and distinguishes the tool from its direct sibling zemax_remove_material_catalog and other catalog tools like zemax_get_glass_catalogs or zemax_export_glass_catalog.

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 add a catalog versus when to use existing catalogs, or what conditions require this action. It also does not mention the alternative (zemax_remove_material_catalog) or refer to any prerequisite.

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