optivibe-mcp
Lens design with an AI agent. optivibe-mcp gives a coding agent such as Claude Code typed tools for Zemax
OpticStudio, and skills that take a lens from its first form through glass choice to an as-built tolerance check.
It is experimental.

One unattended run: a 60ร objective reworked into a 10ร / NA 0.45 apochromat, polychromatic Strehl โฅ 0.935 at
every field point. How it was done and measured.
pip install optivibe-mcp "optivibe-reference[manual]"
optivibe-build-data --probe
claude mcp add optivibe -- C:/path/to/venv/Scripts/optivibe-mcp.exe
On PyPI and in the official MCP Registry
as io.github.chuang44-tiff/optivibe-mcp. Details: Install.
What it does
- More than 80 typed tools (
optivibe-mcp, in packages/optivibe-harness/) drive OpticStudio over the ZOS-API:
load and edit lenses, analyse, optimize, trial glass swaps and tolerance. Beyond spherical surfaces they author
aspheres, coordinate breaks, fold mirrors, diffraction gratings and gradient-index media. Each returns a result
envelope with read-backs instead of raising, so the agent checks a value rather than assuming a call worked.
- Skills carry a design through its stages: optimize the form, choose glass, then desensitize the lens so more
built copies pass (see Skills).
- A reference layer (
optivibe-reference) grounds the agent's choices: operand and glass lookups and manual
search. Engine-free and licence-free; its data is built locally (see
Build the reference data).
The project ships code only. No vendor data (glass catalog, manual text, operand descriptions) is included; you
generate it from your own licensed OpticStudio install.
Demos
Each demo ships its brief and lens files; demos/ lists them and has a script that re-measures a
lens file.
Prerequisites
- Windows. OpticStudio and the ZOS-API .NET surface are Windows-only.
- Zemax OpticStudio, licensed for the ZOS-API. Developed against
2025 R1 (25.1.0, Premium); other versions are untested. Access is gated at
first engine open on
IsValidLicenseForAPI.
- Python 3.11+.
- .NET Framework โ used automatically. The bootstrap sets
PYTHONNET_RUNTIME=netfx and locates your install directory (via env override,
registry, or a Program Files scan). No manual setup.
Install
From PyPI
In a Python 3.11+ virtual environment:
pip install optivibe-mcp "optivibe-reference[manual]"
optivibe-build-data --probe
optivibe-doctor
Both packages are on PyPI: optivibe-mcp and
optivibe-reference, released together with
matching versions. optivibe-mcp is the server; it brings the reference layer (optivibe-reference) with it. The
[manual] extra (PyMuPDF) is optional and reads your OpticStudio manual PDF (see
Manual install). optivibe-build-data builds the reference data from your own
OpticStudio install, and --probe also runs the two operand probes, which open OpticStudio and
need the ZOS-API licence. optivibe-doctor checks the install. Then
register the server with Claude Code.
optivibe-build-data writes into the installed package's data/ and data/captures/
directories, so install optivibe-mcp into a virtual environment (or with pip install --user)
rather than into a system Python whose site-packages is not writable.
From a clone
Clone the repository, then run one command from its root:
powershell -ExecutionPolicy Bypass -File install.ps1
It creates a virtual environment in .venv, installs both packages, builds the reference
data from your OpticStudio install, runs the doctor, and prints the command that registers
the server with Claude Code. It opens no OpticStudio session. Options:
-Python <path>: the Python 3.11+ to build the environment from, when the python on
PATH is older;
-Probe: also run the two operand probes, which open OpticStudio and need the ZOS-API
licence (see Build the reference data);
-Register: run the claude mcp add command for you.
The script only runs the steps below, which you can also do by hand.
Manual install
From packages/optivibe-harness/:
pip install -e ../optivibe-reference
pip install -e .
Install the reference package first โ the harness loads it in-process, and without
it the reference and lookup tools won't be available.
The [manual] extra (PyMuPDF) reads your OpticStudio manual PDF. It is needed for
both manual search and the operand/tolerance description enrichment (the
build extracts verbatim descriptions from the PDF). Without it, the operand and
tolerance catalogs build synonyms-only (grounding still works โ every entry is
searchable by its synonyms โ but carries no manual descriptions). To get the full
enriched build, install it:
pip install -e "../optivibe-reference[manual]"
A per-package environment.yml (Python 3.11) is provided if you prefer conda.
Then check the install:
python -m optivibe_doctor
It checks the interpreter, the two packages, their dependencies, the reference data and your
OpticStudio install directory, and prints one line per check with a remedy for anything that is
wrong. It opens no OpticStudio session unless you ask: --engine also opens one and proves the
ZOS-API licence, and --boot starts the real server once. On a fresh install the reference-data
checks read WARN until you build the reference data, and the
exit code is 1 while any check warns.
Register with Claude Code
claude mcp add optivibe -- /path/to/python -m optivibe_harness
/path/to/python is the interpreter of the environment you installed into โ pointing it at
a different Python is a common cause of silent failures. You can find it with:
python -c "import sys; print(sys.executable)"
The equivalent JSON configuration:
{ "command": "/path/to/python", "args": ["-m", "optivibe_harness"] }
After a PyPI install you can register the optivibe-mcp command instead. Give its full path
(where optivibe-mcp prints it while the environment is active):
claude mcp add optivibe -- C:/path/to/venv/Scripts/optivibe-mcp.exe
Once the optimizer has settled a lens, three tools help with the glass step. explain_glass_swaps
is read-only: it lists which glass elements carry the colour and Petzval terms. trial_glass_swaps
tries up to four swap sets, each re-optimized beside an unchanged control, and judges them on
measured image quality; it edits the open lens while it runs and restores it at the end.
substitute_glass makes one swap and leaves it in place. The design-glass-matching skill runs
this step.
To have Claude Code ask you before either tool that edits the lens runs, add an ask rule to your
settings (for example .claude/settings.json):
{
"permissions": {
"ask": ["mcp__optivibe__trial_glass_swaps", "mcp__optivibe__substitute_glass"]
}
}
An ask rule takes precedence over an allow rule and still asks under bypassPermissions. In a
headless run (claude -p) or in dontAsk mode there is no one to ask, so a matching call is
denied.
Build the reference data
The reference layer's data is built locally from your own licensed install; nothing
vendor-derived is committed. After a PyPI install, run optivibe-build-data (add --probe
to run the two probes below first); it needs no clone. From a clone, run it from the
repository root:
python packages/optivibe-reference/scripts/build_vendor_data.py
This reads the glass catalog from your .agf files (ZEMAX_GLASSCAT) and, if you
point it at the manual PDF (OPTIVIBE_MANUAL_PDF), indexes it for search.
The operand and tolerance catalogs are built from a live probe of your install's
ZOS-API enum surface. Run the two probes once first (each boots a headless
OpticStudio session, reads the operand/tolerance surface, and reaps it):
python packages/optivibe-reference/scripts/probe_operands.py
python packages/optivibe-reference/scripts/probe_tolerances.py
If an input is missing the corresponding step is skipped: that tool (glass or
manual search, or operand/tolerance lookup) returns a typed "unavailable" result
and the rest of the server keeps working. Details and the data-source ledger are
in PROVENANCE.md.
Running it
OpticStudio is not opened at startup โ the engine is launched on the first tool call
that touches a design, and it works with one design at a time. The reference and
lookup tools work with no engine running โ so install, registration, the reference
build, and every lookup succeed regardless of license tier; the ZOS-API license is
checked only when the engine opens.
A note on trust: tools return a result envelope and don't raise on failure, so a call
completing is not proof it did what you intended. Check the returned value or the
optimizer's verdict rather than the absence of an error.
Skills
The repository includes a few Claude Code skills for common tasks:
| Skill | For |
|---|
design-review | Assess a design against a spec |
design-compare | Compare designs side by side |
design-vision-review | Observe a rendered layout and report what lens data does not show (advisory) |
design-aberration-review | Read the ray fan and field curvature / distortion plots and report how the aberrations are balanced (advisory) |
optimize-loop | Run optimization with monitoring |
design-glass-matching | Choose glass for a settled lens: find the elements that carry the colour or field-curvature terms, trial swaps against a control, and keep a swap only when overall image quality improves |
design-tolerance-desensitize | The last finishing stage: pick the push compensator, find the tolerance hotspots, and keep a change only when the as-built yield improves |
bench-catalog | Benchmark and rank a folder of lens designs against a target spec or each other |
zos-api-debug | Troubleshoot OpticStudio connection / license errors |
Status
Experimental, early-stage and provided as-is; expect rough edges. It has been developed
and exercised against a single OpticStudio version (2025 R1) on Windows; behavior on
other versions is unverified. Interfaces and tool coverage may change.
Running another OpticStudio version or licence tier? Please
open an issue with the output of python -m optivibe_doctor --engine,
whether it works or not. A report that it works on your version is as useful as a bug.
Bug reports, questions, and pull requests are welcome via
GitHub Issues and pull requests; see CONTRIBUTING.md.
Please don't include any vendor-derived data (glass catalogs, manual text, operand
descriptions) in issues or PRs โ see PROVENANCE.md.
Licensing & provenance
optivibe-mcp is licensed under the Apache License 2.0 โ see LICENSE
and NOTICE.
It is code-only and drives your own licensed OpticStudio install at runtime; no
vendor data or SDK files are redistributed. The reference data you build locally
stays local (it is gitignored). optivibe-mcp is an independent project and is not
affiliated with or endorsed by Ansys/Zemax. See PROVENANCE.md for
the data-source and license ledger.