zemax_nsc_clear_detectorsClear all non-sequential detectors in Zemax OpticStudio, or remove a single detector by object number, to reset ray-trace detector data before a new simulation.
Clear all or one non-sequential detector.
| Name | Required | Description | Default |
|---|---|---|---|
| objectNumber | No | 0 clears all |
Changes observed during successful MCP inspections.
v0.1.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
No annotations are provided, so the description carries the full burden. It doesn't disclose whether clearing is reversible, what happens to detector data, or any side effects. 'Clear' implies deletion, but the description is silent on behavioral traits beyond the basic action.
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?
A single, front-loaded sentence that is exactly as long as needed. No wasted words.
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?
For a simple clear operation with one optional parameter and no output schema, the description is minimally adequate. However, with no annotations, it should at least mention whether clearing is destructive or reversible, or what happens to the cleared detectors, to be fully complete.
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?
Schema coverage is 100%, so the schema already documents the objectNumber parameter and its default. The description adds the scope semantics ('all or one'), which is useful context, but the schema description ('0 clears all') already covers this. Baseline 4 for 0 required params with full schema coverage is appropriate.
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?
States a specific verb (clear) and resource (non-sequential detector), and specifies the scope (all or one). It is easily distinguished from sibling detector tools like zemax_nsc_detector_data or zemax_nsc_load_detector, which read or load rather than clear.
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 implies when to use it (to clear detectors), but doesn't explicitly state when not to use it or name alternatives. Usage is inferable from the purpose but lacks explicit guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.