cst-studio-mcp
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@cst-studio-mcp Design a patch antenna, run simulation, and show S11 plot"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
cst-studio-mcp
Python-first MCP server for CST Studio Suite · version 1.1.0
Based on mcp-cst-studio by RFingAdam, licensed AGPL-3.0-or-later. This project builds on its server and tool catalog; see NOTICE for provenance and changes, and License for the scope of the server/package license.
Drive CST from an AI assistant: open projects, build geometry, set materials and ports, run solvers, read S-parameters and farfield metrics, and generate design reports — through structured MCP tools on your Windows machine.
Package |
|
Tools | 180+ (workflows, geometry, antennas, solvers, results, PCB, …) |
Python | 3.10+ (3.12 recommended) |
OS | Windows 10/11 + licensed CST Studio Suite |
Docs | Interactive EN/TR browser: |
Project presentation: presentation/index.html, a self-contained
Turkish architecture and validation overview. See the reliability review
for historical checks. Current evidence and limits are in the 2026 API review.
Start with the agent installation and acceptance guide. Official Python results were verified against all 4 × 4,001 complex samples in a completed CST 2026 project; an isolated modeler fixture also passed. The full tool catalog is not a blanket certification of advanced CST features.
Agent (Cursor / Claude / …)
│ MCP stdio
▼
cst-studio-mcp server
│
├─ Python API connect · project · solve · results (cst.interface / cst.results)
└─ History VBA geometry · materials · ports · monitors (model3d.add_to_history)
│
▼
CST Studio Suite (local install + license)Table of contents
Related MCP server: CST Studio Orchestrator MCP
What you get
Full tool surface — project control, geometry, booleans, transforms, materials, ports, boundaries, mesh, solvers, simulation control, results, import/export, parameters, optimization helpers, antenna templates, arrays, PCB/SI, matching networks, VBA escape hatch.
Workflow helpers — one-shot patch antenna, solve + S11, design report, structure views, farfield discovery/metrics.
Portable paths — auto-detects CST on any drive letter; prefers
AMD64\python_cst_libraries(CST 2024–2026). No hard-codedE:\in library code.Bilingual docs — English / Türkçe tool browser with light/dark theme.
Offline fallback — if CST is unreachable, many tools still return VBA for manual paste.
Requirements
Component | Notes |
Windows | 10 or 11 (64-bit) |
CST Studio Suite | Core paths tested on 2026; its Python result reader supports saved 2025/2026 files. Other versions need local acceptance |
CST license | Valid license for the solver you use |
Python | 3.10 – 3.13 (3.12 works well with CST’s bundled |
Disk | CST install + project work directory (simulations can be large) |
CST Python libraries ship with the product, typically:
<CST_ROOT>\AMD64\python_cst_librariesExamples:
C:\Program Files\CST Studio Suite 2026\AMD64\python_cst_librariesE:\CST Studio Suite 2026\AMD64\python_cst_libraries
Installation
1. Clone the repository
git clone https://github.com/ismailakdag/cst-studio-mcp.git
cd cst-studio-mcp2. Create a virtual environment and install (recommended)
In PowerShell, from the repo root (the folder that contains pyproject.toml):
python -m venv .venv
.\.venv\Scripts\Activate.ps1
pip install -U pip
pip install -e ".[dev]"This installs:
Runtime dependencies:
mcp>=1.29,<3,anyio>=4.5, andjsonschema>=4.20Console script:
cst-studio-mcp(also at.\.venv\Scripts\cst-studio-mcp.exe)Dev extras:
pytest,pytest-asyncio,ruff
Tip: open
docs/index.html— the Setup section has Copy buttons for every PowerShell block, and a form that fills CST_PATH / PYTHONPATH / MCP JSON from the path you type.
3. Point Python / MCP at your CST install
You must tell the process where CST lives. Typical roots:
C:\Program Files\CST Studio Suite 2026E:\CST Studio Suite 2026
Not the AMD64 folder itself — one level above. PYTHONPATH then points at:
%CST_PATH%\AMD64\python_cst_libraries
Session-only (current PowerShell window)
Replace the path with yours, then paste:
$env:CST_PATH = "C:\Program Files\CST Studio Suite 2026"
$env:PYTHONPATH = "$env:CST_PATH\AMD64\python_cst_libraries"
$env:CST_WORK_DIR = "C:\cst_projects"
$env:CST_VERSION = "2026"
New-Item -ItemType Directory -Force -Path $env:CST_WORK_DIR | Out-NullPermanent (optional, Windows user env)
[Environment]::SetEnvironmentVariable("CST_PATH", "C:\Program Files\CST Studio Suite 2026", "User")
[Environment]::SetEnvironmentVariable("PYTHONPATH", "C:\Program Files\CST Studio Suite 2026\AMD64\python_cst_libraries", "User")
[Environment]::SetEnvironmentVariable("CST_WORK_DIR", "C:\cst_projects", "User")For Cursor / Claude / other MCP clients, prefer putting the same keys in the server env block (next section) — that is what the AI process actually sees.
Environment variables
Nothing in the library hard-codes a drive letter. Discovery order:
If
CST_PATHis set → use itElse scan all drive letters for
CST Studio Suite {CST_VERSION}Resolve
AMD64\python_cst_libraries(fallbackLinuxAMD64\...on dual layouts)
Variable | Required | Meaning | Example |
| Recommended | CST install root |
|
| Strongly recommended | Official CST Python package path |
|
| Optional | Projects, exports, reports |
|
| Optional | Year for auto-detect (default |
|
| Legacy | Accepted for compatibility; connecting no longer changes the user's CST UI mode |
|
| Optional | Startup behavior: |
|
| Optional | Logging level |
|
| Optional | Comma-separated tool categories to expose (default: all). Alias |
|
| Optional | Default off. Set to |
|
auto attaches to a running Design Environment or starts one when the MCP process starts.
Use disabled for catalog inspection, client setup checks, and offline VBA generation: it does
not import the CST Python package or connect to CST. manual skips the startup connection while
leaving CST available to the explicit cst_connect tool and connection workflows. It is the default, so adding an MCP server never implicitly launches CST. cst_disconnect detaches the MCP session; it does not close the application or its projects.
Template file: .mcp.example.json
Local machine paths: .mcp.json (edit paths only; keep out of shared commits if needed).
MCP client setup
Claude Desktop / Cursor JSON config
{
"mcpServers": {
"cst-studio": {
"command": "cst-studio-mcp",
"args": [],
"env": {
"CST_PATH": "C:\\Program Files\\CST Studio Suite 2026",
"CST_WORK_DIR": "C:\\cst_projects",
"CST_VERSION": "2026",
"CST_CONNECT_MODE": "manual",
"PYTHONPATH": "C:\\Program Files\\CST Studio Suite 2026\\AMD64\\python_cst_libraries",
"CST_LOG_LEVEL": "INFO"
}
}
}
}If cst-studio-mcp is not on PATH (for example a venv), use the full executable:
"command": "C:\\path\\to\\cst-studio-mcp\\.venv\\Scripts\\cst-studio-mcp.exe"Or:
"command": "python",
"args": ["-m", "cst_mcp.server"](with PYTHONPATH including CST libs).
Codex
Add the server to your Codex config.toml. Literal single-quoted TOML strings keep Windows
backslashes intact; replace the example paths with your local installation paths.
[mcp_servers.cst-studio]
command = 'C:\path\to\cst-studio-mcp\.venv\Scripts\cst-studio-mcp.exe'
args = []
[mcp_servers.cst-studio.env]
CST_PATH = 'C:\Program Files\CST Studio Suite 2026'
CST_WORK_DIR = 'C:\cst_projects'
CST_VERSION = '2026'
CST_CONNECT_MODE = 'manual'
PYTHONPATH = 'C:\Program Files\CST Studio Suite 2026\AMD64\python_cst_libraries'Reload the MCP configuration, confirm the cst-studio tools are available, and call
cst_connect only when you are ready to attach to CST. See the
official Codex MCP documentation for current
configuration locations and controls.
Cursor
Open Cursor Settings → MCP (or project MCP JSON / root
.mcp.json, depending on Cursor version).Add the
cst-studioserver block with yourCST_PATHandPYTHONPATH.Restart MCP / reload the window.
Confirm the full tool list (180+) under server
cst-studio(fewer ifCST_TOOLSETSis set).
After code changes, restart the MCP server process so Python reloads the package.
Claude Desktop
Edit the Claude Desktop config JSON (Windows typically under %APPDATA%\Claude\) and add the same mcpServers.cst-studio block. Fully quit and restart Claude Desktop.
Claude Code / CLI
Register the server in one line (user scope; use --scope project to write a shared .mcp.json instead):
claude mcp add cst-studio --scope user -e CST_PATH="C:\Program Files\CST Studio Suite 2026" -e PYTHONPATH="C:\Program Files\CST Studio Suite 2026\AMD64\python_cst_libraries" -e CST_WORK_DIR="C:\cst_projects" -e CST_CONNECT_MODE=manual '--' "C:\path\to\cst-studio-mcp\.venv\Scripts\cst-studio-mcp.exe"Everything after -- is the server command. In PowerShell keep the quotes around '--': if claude resolves to the npm .ps1 shim, PowerShell otherwise strips a bare --. Check it with claude mcp list (or /mcp inside a session). Alternatively, add the same command + env to your MCP config JSON. Restart the session after edits.
Other MCP hosts
Any client that supports MCP stdio servers can use cst-studio-mcp with the same environment variables.
The process uses newline-delimited JSON-RPC on stdout. Logs and diagnostics are written to stderr,
so clients must keep stdout reserved for MCP messages. For a first client-side check, set
CST_CONNECT_MODE to disabled, restart the MCP process, and verify that initialize, tools/list,
and cst_connection_status succeed. Change it to auto only when the client configuration points
to the intended CST installation.
MCP clients use two common configuration envelopes. Clients such as Claude Desktop and Cursor use
the mcpServers object shown above. Clients whose schema uses a servers object generally need the
same process definition in this shape:
{
"servers": {
"cst-studio": {
"type": "stdio",
"command": "C:\\path\\to\\.venv\\Scripts\\cst-studio-mcp.exe",
"args": [],
"env": {
"CST_PATH": "C:\\Program Files\\CST Studio Suite 2026",
"CST_WORK_DIR": "C:\\cst_projects",
"CST_CONNECT_MODE": "manual"
}
}
}
}Use the field names required by the client, but keep command, args, and env unchanged. Prefer
the absolute console-script path on Windows; it avoids differences in each client's PATH.
Tools carry MCP annotations (readOnlyHint / destructiveHint), so clients that honor them can
auto-approve read-only tools and still prompt for mutating ones. Some result tools also declare an
outputSchema and return structuredContent alongside the text result.
Verify the install
# 1) Package entry point exists
Get-Command cst-studio-mcp
# 2) CST Python libs importable
python -c "import cst.interface; print('CST interface OK')"
# 3) Config auto-detect
python -c "from cst_mcp.config import CSTConfig; c=CSTConfig.from_env(); print(c.cst_path); print(c.python_lib_path); print('available', c.cst_available)"
# 4) Offline unit tests (no live solve required)
python -m pytest tests/ -q
# If global pytest plugins break collection, disable autoload but load pytest-asyncio explicitly:
# $env:PYTEST_DISABLE_PLUGIN_AUTOLOAD = "1"; python -m pytest tests/ -q -p asyncioFrom an MCP client, call:
cst_connect— explicitly attach to CST when ready (or opt intoCST_CONNECT_MODE=auto); thencst_connection_statusreports the session. Withdisabled, the server remains offline.Prefer workflows for smoke tests (see below)
Quick start (agents)
Recommended order for a first successful run:
Step | Tool | Purpose |
1 |
| Confirm connected mode |
2 |
| Parametric microstrip patch (substrate, ground, feed, WG port, farfield monitor) |
3 |
| Solve |
4 |
| S11 + antenna metrics |
5 |
| Package: params, S-params, farfield, views |
Long solves: for anything that takes longer than about a minute, start it with
cst_run_simulation_async, then call cst_wait_for_simulation repeatedly until it reports
completion. Each wait call returns within about max_wait_s + 2 s (default max_wait_s 45),
which keeps individual calls under typical client tool-call timeouts. A wait that sees the
solver idle before the async start was observed keeps polling (status starting) instead of
reporting a premature finished. All CST calls run on one dedicated worker thread, so a long
blocking cst_run_simulation queues other CST tools but no longer freezes the MCP server.
Other useful entry points:
cst_antenna_patch— template builder (similar geometry stack)cst_design_patch_only— offline dimension calculator (no CST)cst_export_structure_views— multi-view structure imagescst_discover_farfield_monitors— find farfield results on disk
Publication figures (install the extra: pip install -e ".[figures]", i.e. numpy + matplotlib):
cst_plot_1d_results— IEEE-style S11 / S-parameters / VSWR / Smith / impedance / phase / efficiency figures read directly from a saved.cst(no GUI), with resonance and −10 dB band annotation, run comparison and measured-CSV overlay. Returnsno_resultswith next steps when the project has not been solved.cst_plot_farfield— polar E/H cuts, rectangular cuts, θ–φ or u–v heatmaps and 3D patterns, with max gain, HPBW, F/B, SLL and XPD. Works offline from a CST farfield ASCII export or exports it itself when connected;no_resultsdistinguishes a missing monitor from an unsolved one.cst_technical_drawing— dimensioned orthographic drawing (top/front/side/iso) of the model with title block and parameter table, as PDF/SVG/PNG. Exports each solid as STL (in mm) without touching model history, or renders offline from an existing STL folder.
Parametric tip: dimensions should live in the CST Parameter List and geometry history
should use expressions (for example patch_L/2). Then parameter change → delete results →
rebuild → solve updates the model without rewriting history by hand.
Farfield & results notes
These details matter for reliable automation on CST 2026:
Topic | Guidance |
Monitor VBA | Official |
Tree path | After TD solve: |
Metrics API | Prefer |
MCP tool |
|
1D Results |
|
Architecture
src/cst_mcp/
server.py MCP entry (stdio)
config.py Multi-drive CST discovery
session.py Design Environment / project / solve / export / farfield metrics
cst_client.py Public client façade used by tools
tools/ One module per category (workflows, geometry, …)
execution/ VBA helpers, port VBA, farfield, results_api, CSV readers
domain/ Pure design math (e.g. patch sizing)
data/ Material / template JSONLayer | Role |
MCP tools | Schemas + handlers; agent-facing |
CSTClient / Session | Connection lifecycle, history VBA, Python solver/results |
execution/ | Portable VBA snippets (ports, farfield metrics dump) |
CST product | Mesh, TD/FD solvers, result tree |
Reference / upstream history (not required at runtime): _reference/.
Official VBA object dump for alignment: vba_cst/.
Documentation site
Path | Content |
Interactive EN/TR tool browser, light/dark, search, copy full tool text, install guide | |
Markdown catalog | |
Machine-readable schemas | |
VBA fixes vs CST Online Help dump | |
How to open/rebuild docs |
# Open UI
start docs\index.html
# Or local server
python -m http.server 8080 --directory docs
# Rebuild HTML + JSON + Markdown + README catalog from live tools
python scripts/build_docs.pyDevelopment & tests
pip install -e ".[dev]"
$env:PYTEST_DISABLE_PLUGIN_AUTOLOAD = "1" # optional: avoid broken global pytest plugins
python -m pytest tests/ -v -p asyncio # -p asyncio is required when autoload is disabled
python scripts/build_docs.py
ruff check src testsOptional live CST scripts under scripts/ (require license). Prefer unit tests for offline checks.
Troubleshooting
Symptom | What to try |
| Set |
MCP shows few tools / old behavior | Restart the MCP server process after |
| Set |
Port “floating” in air | Free port plane with |
Farfield Message spam / “No HEX mesh” | Avoid |
SelectTreeItem fails for farfield | Full path |
Parameter List empty / rebuild no shape change | History must use parameter expressions, not only bare numbers. |
Dialogs block automation |
|
| Editing the model of a solved project makes CST open that modal dialog inside the automation call, where it cannot be answered. Model-editing tools now refuse with |
pytest plugin import errors |
|
Upstream and development
The upstream already used the official CST Python API. Development here builds on that foundation, including explicit CST session/launch controls and safety guards; complex saved-result analysis and official-help search; publication figures, farfield metrics and STL technical drawings; real inset cuts and probe feed geometry; and regression tests and usage documentation. See NOTICE for the source files behind these changes and the imported baseline.
License
The server/package, bundled JSON data, supporting Python scripts, tests and package/build configuration are licensed under GNU AGPL version 3 or (at your option) any later version, SPDX AGPL-3.0-or-later. The complete license is in LICENSES/AGPL-3.0-or-later.txt; LICENSE defines the scope and NOTICE preserves attribution and change notices.
This correction does not relicense all website, documentation or presentation content. Generated/copied server tool descriptions and schemas retain the server's terms; independent content and third-party assets retain their own applicable terms. Inter and Source Serif 4 remain under SIL OFL 1.1. CST Studio Suite and its libraries are separate proprietary products.
Commercial use is permitted under the AGPL's conditions. When distributing a modified version, preserve the license and notices and identify your changes and their dates (sections 4–5). For object-code distributions, provide the Corresponding Source as required by section 6; publish the matching sdist and build instructions alongside each wheel, with a clear source link and the exact revision, rather than relying only on a moving default branch.
The current server uses local MCP stdio. If you expose a modified version to users through a network service or gateway, section 13 requires a prominent, no-charge offer of the Corresponding Source for that running version. Put that offer where remote users interact with the service; a repository link alone must not be assumed to cover unpublished deployment changes. Keep MCP stdout reserved for protocol messages. Source: this repository.
Full tool catalog (192 tools)
Interactive bilingual docs: open docs/index.html (EN/TR toggle, search, full-width cards). Rebuild: python scripts/build_docs.py.
VBA for geometry/ports/transforms is cross-checked against the CST help dump in vba_cst/.
Official API and saved results (4)
Read local CST Python/VBA help and complex saved results without opening CST.
Tool | What it does |
| Full-text search of the installed official CST Python/VBA help (offline; does not start CST). Every query word must appear in the topic's… |
| Read a paginated official local CST help topic returned by cst_search_help. No GUI or solver. |
| List exact result tree paths and run IDs from a saved, unpacked, completed .cst file using cst.results. No connection or CST GUI is requi… |
| Read a complete complex 1D curve by exact tree path and run_id from a completed saved .cst, without opening CST. Raw real/imag are preser… |
Explicit connection (2)
Attach to CST explicitly; disconnect without closing user projects.
Tool | What it does |
| Explicitly attach to a CST Design Environment (DE). Disabled mode never connects. mode='any' (default) uses connect_to_any_or_new(): it a… |
| Detach this MCP session without closing CST, projects, or a running solver. |
Workflows (start here) (8)
One-shot helpers for common tasks. New users should start here.
Tool | What it does |
| END-TO-END / Uçtan uca: size a rectangular microstrip patch, build substrate/ground/patch/feed, frequency, open BCs, waveguide port, farf… |
| Run solver and return structured S11/Sij with metrics (min dB, bandwidth). BLOCKING: waits for the whole solve (up to timeout_s) inside o… |
| Calculate microstrip patch dimensions only (offline, no CST). Sadece boyut hesabı — CST gerekmez. |
| Export structure screenshots (perspective/xy/xz/yz) via Plot.ExportImage. Yapı görünüm görsellerini dışa aktarır. Connected mode required. |
| ONE-SHOT design package after modeling/simulation: project status, parameters/dimensions, S-parameters (+metrics), best-effort farfield e… |
| Run the solver, then immediately build a design report (S-params + views + optional farfield). BLOCKING: waits for the whole solve (up to… |
| Discover farfield monitors from the project Result folder and tree-path heuristics. Uzak alan monitörlerini disk + path sezgisiyle listeler. |
| Read antenna metrics after a solve: S11 + radiation/total efficiency from 1D Results, plus max realized gain via official FarfieldPlot.Ge… |
Project & connection (8)
Create, open, save projects and check CST connection.
Tool | What it does |
| Create a new CST Studio Suite project file. In connected mode the project is created directly; in offline mode a VBA script is returned f… |
| Open an existing CST Studio Suite project. In connected mode the project is opened in the running instance; in offline mode a reference i… |
| Save the currently open CST project. Optionally provide a new path to 'Save As'. |
| Close the currently open CST project and release its resources. |
| Get information about the currently open CST project, including connection mode, project path, and status. |
| List items in the CST project navigation tree. Optionally specify a subtree path such as 'Components', 'Materials', 'Ports', 'Monitors', … |
| Export the current CST project or its geometry to another format such as STL, STEP, IGES, SAT, OBJ, or NASTRAN. |
| Get the current CST Studio connection status, including mode (connected/offline), CST availability, version, and work directory. |
Geometry (13)
3D shapes: bricks, cylinders, spheres, extrusions, wires…
Tool | What it does |
| Create a rectangular brick (box) in CST Studio. |
| Create a cylinder in CST Studio. Use inner_radius=0 for a solid cylinder. |
| Create a cone or truncated cone in CST Studio. |
| Create a sphere in CST Studio. |
| Create a torus in CST Studio. |
| Extrude a 2D polygon profile into a 3D solid in CST Studio (Extrude object, Mode 'pointlist'). The profile lies in the plane normal to 'a… |
| Create a lofted solid between two or more 2D profiles in CST Studio. |
| Create a bondwire / wire between two points in CST Studio. |
| Create a 3D polygon curve in CST Studio. |
| Create a parametric analytical curve in CST Studio using expressions of parameter t. |
| Create a planar face from one or more closed curves in CST Studio. |
| Create an elliptical cylinder in CST Studio. |
| Create a polygon and extrude it along an axis in CST Studio. Convenience tool combining polygon profile creation (Polygon3D curve) and ex… |
Boolean operations (4)
Combine solids: add, subtract, intersect, insert.
Tool | What it does |
| Unite/add two solids together. The result replaces solid1 with the combined volume of both shapes. |
| Subtract solid2 from solid1. The overlapping volume of solid2 is removed from solid1. Solid2 is deleted. |
| Intersect two solids. Only the overlapping volume is kept, replacing solid1. Solid2 is deleted. |
| Insert solid2 into solid1. Solid2 is embedded within solid1, maintaining both material regions at the overlap. |
Transforms (4)
Move, rotate, mirror, and scale solids.
Tool | What it does |
| Translate (move) a solid by a displacement vector (dx, dy, dz). Optionally create a translated copy. |
| Rotate a solid by a given angle around an axis (x, y, or z). An optional center point can be specified. |
| Mirror a solid across a plane (xy, xz, or yz). An optional center point can be specified. |
| Scale a solid by independent factors along each axis. An optional center point can be specified. |
Materials (15)
Metals, dielectrics, and advanced material models.
Tool | What it does |
| Create a new material with electromagnetic properties in CST Studio. Specify relative permittivity (epsilon), relative permeability (mu),… |
| Create a lossy metal material in CST Studio. Lossy metals model finite conductivity skin-effect losses, essential for accurate loss calcu… |
| Create an anisotropic material with per-axis permittivity, permeability, and loss tangent values. Used for crystals, metamaterials, and c… |
| Load a material from the CST material library by its library name. The material is added to the project under the given name. |
| List available materials from the bundled material database. Optionally filter by category: 'metals', 'dielectrics', or 'substrates'. Ret… |
| Assign a material to an existing solid in CST Studio. The solid is specified as 'Component:SolidName'. |
| Get electromagnetic properties of a material from the bundled database. Returns epsilon_r, mu_r, conductivity, loss tangent, and usage no… |
| Delete a material from the current CST project. |
| Create a frequency-dependent dielectric material using the Debye relaxation model. Models polar dielectrics where permittivity decreases … |
| Create a Lorentz oscillator dispersive material. Models resonant dielectric behaviour near absorption bands: eps(w) = eps_inf + delta_eps… |
| Create a Drude metal model material for plasmonic and metamaterial simulations. Models free-electron metals: eps(w) = 1 - wp^2 / (w^2 + j… |
| Create a ferrite material with gyrotropic permeability tensor (Polder model). Essential for circulators, isolators, and phase shifters. T… |
| Create a material with temperature-dependent electromagnetic properties. Specify base properties and temperature coefficients for thermal… |
| Create a Cole-Cole dispersive material. Generalisation of the Debye model with a distribution parameter alpha (0-1) that broadens the rel… |
| List available ferrite materials from the bundled database. Returns name, permittivity, saturation magnetisation, linewidth, loss tangent… |
Ports & excitations (8)
Waveguide, discrete, plane wave, Floquet…
Tool | What it does |
| Add a waveguide port for S-parameter excitation. Defines a port face on the boundary of the simulation domain for guided-wave excitation.… |
| Add a discrete (lumped) port between two points. Used for circuit-level excitation with a defined impedance. |
| Add a lumped R, L, C, or RLC element between two points. Value is in ohms for R, henries for L, farads for C. |
| Add a plane wave excitation source. Defines an incident plane wave with given direction and polarization for scattering / RCS analysis. |
| Add a Floquet port for periodic structures such as frequency selective surfaces, metamaterials, and phased arrays. |
| List all ports defined in the current CST project. Returns VBA to query port information, or a description in offline mode. |
| Delete a port by its port number. |
| Add a waveguide port with multiple mode monitoring for higher-order mode analysis. Used for multimode waveguides, mode converters, and st… |
Boundaries & setup (6)
Open/electric walls, background, symmetry, frequency range.
Tool | What it does |
| Set boundary conditions for the simulation domain. Each face of the bounding box can be assigned an independent boundary type (open, elec… |
| Set the background material properties of the simulation domain. The background fills all space not occupied by defined solids. |
| Set symmetry planes to reduce computation time. Each axis can be assigned electric or magnetic symmetry, or none. Requires the model geom… |
| Set the simulation frequency range in GHz. This determines the bandwidth over which the solver computes results. |
| Configure periodic boundary conditions with optional phase shift for unit cell simulation. Sets X and Y boundaries to periodic and config… |
| Configure advanced Floquet port settings for periodic structures. Controls the number of Floquet modes and scan angle for phased array el… |
Mesh (8)
Mesh type, density, refinement, adaptive meshing.
Tool | What it does |
| Set the mesh type for the simulation. Hexahedral is used for time-domain, Tetrahedral for frequency-domain, Surface for integral-equation… |
| Set global mesh density parameters controlling automatic mesh generation. Higher cells_per_wavelength gives finer mesh and better accurac… |
| Add local mesh refinement to a specific solid. This creates finer mesh around critical geometry features like feed points, gaps, or thin … |
| Configure adaptive mesh refinement. When enabled, the solver runs multiple passes, refining the mesh in regions of high field gradient un… |
| Get current mesh statistics and settings. In connected mode this queries the live mesh data; in offline mode it returns the VBA to retrie… |
| Extract mesh quality metrics including total cells, aspect ratios, and cells per wavelength. In connected mode this queries actual mesh s… |
| Configure PML (Perfectly Matched Layer) absorbing boundary properties. Controls the number of absorbing layers and the target reflection … |
| Add a fixed mesh point at specific coordinates for precise field sampling. Ensures the mesh contains a node exactly at the specified loca… |
Solvers (8)
Time domain, frequency domain, eigenmode, IE…
Tool | What it does |
| Configure the time domain (transient) solver. This is CST's flagship solver for broadband simulations — it excites the structure with a p… |
| Configure the frequency domain solver. Best for narrowband problems, resonant structures, and when field distributions at specific freque… |
| Configure the eigenmode solver. Computes resonant frequencies and field distributions of cavity structures. Used for filter design, reson… |
| Configure the integral equation (IE) solver. Best for electrically large, open-boundary problems like antenna placement on vehicles, RCS … |
| Get current solver configuration and status. In connected mode this queries the active solver settings; in offline mode it describes expe… |
| Advanced eigenmode solver configuration for higher-order modes. Use this for waveguide mode analysis, cavity resonator design, and filter… |
| Advanced Integral Equation solver configuration for electrically large structures. Provides control over preconditioner, MLFMM accelerati… |
| Configure the solver for planar multilayer structures. Optimised for antenna-on-PCB, frequency selective surfaces (FSS), and radome analy… |
Simulation control (7)
Run, pause, resume, stop simulations.
Tool | What it does |
| Start a CST simulation with the current solver settings and block until it completes (up to timeout_s). The server stays responsive, but … |
| Start a CST simulation asynchronously (non-blocking). The simulation launches and control returns immediately. Then call cst_wait_for_sim… |
| Read whether a CST simulation is running and return any solver-run metadata exposed by the CST Python API. This does not show a dialog or… |
| Wait a bounded time for the running CST solve to finish, polling only the read-only 'is solver running' flag about every 2 s. Returns sta… |
| Pause a currently running CST simulation. The simulation can be resumed later with cst_resume_simulation. |
| Resume a previously paused CST simulation. Use after cst_pause_simulation to continue from where it stopped. |
| Stop and abort a running CST simulation. Unlike pause, a stopped simulation cannot be resumed — it must be restarted from the beginning. |
Results (22)
S-parameters, far-field, VSWR, gain, Smith, bandwidth…
Tool | What it does |
| Extract S-parameter results from a completed CST simulation. Returns S-parameter data (magnitude, phase, real/imaginary) for the specifie… |
| Get far-field radiation pattern results from a completed CST simulation at a specific frequency. Returns gain, directivity, radiation eff… |
| Add a field monitor at a specific frequency to the CST project. Field monitors must be defined before running a simulation to capture fie… |
| Get input impedance (Z-parameters) for a port from a completed CST simulation. Returns real and imaginary impedance vs frequency. Useful … |
| Get Voltage Standing Wave Ratio (VSWR) for a port from a completed CST simulation. VSWR indicates impedance matching quality: 1.0 is perf… |
| Get antenna gain at a specific frequency from a completed CST simulation. Returns peak gain in dBi and the direction (theta, phi) of maxi… |
| Get antenna radiation efficiency from a completed CST simulation at a specific frequency. Returns total efficiency (including mismatch), … |
| List all available results in the CST result tree. Optionally specify a subtree path to narrow the listing. Useful for discovering what s… |
| Export a simulation result to a file (CSV, Touchstone, or text). Specify the result tree path and desired output format. Useful for post-… |
| Get a summary of all key simulation results from a completed CST simulation. Returns an overview of S-parameters, gain, efficiency, and i… |
| Extract S-parameter phase response from a completed CST simulation. Returns the phase of the specified S-parameter vs frequency. Optional… |
| Compute group delay from S-parameter phase for a port pair. Group delay is defined as tau = -d(phase)/d(2pif) and represents the signal… |
| Extract an E-plane, H-plane, or custom radiation pattern cut from a completed CST simulation at a specific frequency. Returns gain vs ang… |
| Extract cross-polarization level and cross-polarization discrimination (XPD) from a completed CST simulation. Supports Ludwig-3, Ludwig-2… |
| Extract axial ratio for circularly polarized antennas from a completed CST simulation. Axial ratio (AR) indicates the quality of circular… |
| Extract surface current density distribution from a completed CST simulation at a specific frequency. Useful for understanding current fl… |
| Get a detailed efficiency breakdown with loss budget from a completed CST simulation. Returns radiation efficiency, total efficiency, and… |
| Extract time-domain port signal waveforms from a completed CST time-domain simulation. Returns incident, reflected, or transmitted signal… |
| Extract Smith chart formatted impedance data from a completed CST simulation. Computes normalized impedance from S11 reflection coefficie… |
| Calculate impedance bandwidth from S-parameter results. Finds the frequency range where S11 (or VSWR) meets the specified threshold. Retu… |
| Export full 3D radiation pattern data from a completed CST simulation at a specific frequency. Returns gain values over the full sphere i… |
| Extract volume current distribution from a completed CST simulation at a specific frequency. Complements surface current extraction by pr… |
Import / export (5)
CAD and Touchstone import/export, far-field export.
Tool | What it does |
| Import a CAD file into CST Studio. Supports STEP (.stp/.step), IGES (.igs/.iges), STL (.stl), SAT/ACIS (.sat), DXF (.dxf), and OBJ (.obj)… |
| Export the current CST model (or a specific component) to a CAD format. Supports STL, SAT/ACIS, STEP, IGES, OBJ, and NASTRAN. |
| Import a Touchstone S-parameter file (.s1p, .s2p, .snp) into CST Studio for use as a reference or circuit element. |
| Export S-parameter simulation results to a Touchstone file. Requires a completed simulation with S-parameter data. |
| Export far-field radiation pattern data to a file. Requires a completed simulation with far-field monitor results. |
Parameters & optimizers (11)
Design parameters, sweeps, optimizers, sensitivity, yield.
Tool | What it does |
| Set or create a design parameter in CST Studio. Parameters can hold numeric values or string expressions referencing other parameters. Th… |
| Get the current value of a design parameter. Returns both the stored expression and the evaluated numeric value. |
| List all design parameters in the current CST project with their names, expressions, and evaluated numeric values. |
| Delete a design parameter from the CST project. The parameter must not be referenced by other parameters or geometry. Uses the parameter … |
| Configure a CST parameter sweep (ParameterSweep object; not a model-history step) that solves once per sample of the parameter. By defaul… |
| Configure the native CST optimizer (Optimizer object; not a model-history step). Define a goal (minimize, maximize, or target a value for… |
| Set up a multi-objective optimization with weighted goals and optional constraints. Uses a weighted sum of goals with an evaluation cap; … |
| Set up a one-at-a-time sensitivity analysis to rank parameters by their impact on a result. Varies each parameter individually while keep… |
| Set up a Monte Carlo yield analysis to estimate manufacturing yield. Randomly varies parameters according to their tolerances and evaluat… |
| Single-objective optimization with explicit inequality constraints. Example: minimize S11 subject to gain > 8 dBi and bandwidth > 100 MHz… |
| Read-only: linearly interpolate a saved 1D result between the two parameter sweep runs that bracket target_value (runs come from a finish… |
Antenna evaluation (3)
Goal-driven evaluation and refinement helpers.
Tool | What it does |
| Evaluate current antenna simulation results against performance goals. Exports S-parameter data and checks VSWR (or return loss) against … |
| Analyze antenna impedance match quality across frequency bands using S-parameter data. Exports S11 from a completed simulation, computes … |
| Run an automated Nelder-Mead optimization loop to tune CST design parameters toward VSWR goals across specified frequency bands. Each ite… |
Diagnostics (7)
Logs, delete results, auto-dismiss blocking CST dialogs.
Tool | What it does |
| Delete simulation results from the current CST project. This prevents the 'Results May Get Incompatible With Model' dialog that blocks au… |
| Read solver log files and project status information from the current CST project. Returns solver running state and the contents of the m… |
| Find and dismiss any visible CST dialog windows (error popups, 'Results Incompatible' dialogs, solver warnings). Returns the title and te… |
| Start a background thread that automatically detects and dismisses CST dialog windows as they appear. Essential for long-running operatio… |
| Stop the background dialog watcher and return its log of all dialogs that were auto-dismissed. Use after completing an operation that req… |
| Read-only power-balance diagnostic. From 1D Results\Power\Excitation [n]\ (Power Stimulated/Accepted/Radiated, Loss in Dielectrics/Metals… |
| Read-only sanity check of a described setup (nothing is sent to CST). Warns when a waveguide port sits on an 'open' (no added space) boun… |
Antenna templates (13)
Parametric antennas: patch, dipole, horn, Yagi, helix…
Tool | What it does |
| Create a rectangular microstrip patch antenna with calculated dimensions for a target frequency. Supports inset, microstrip, and probe fe… |
| Create a half-wave dipole antenna at a target frequency. Generates two wire arms with a discrete port at the feed gap. |
| Create a quarter-wave monopole antenna over a ground plane. Generates a vertical wire element, ground plane, and feed port. |
| Create a pyramidal horn antenna for a target frequency and gain. Generates the waveguide section, flared horn, and waveguide port. |
| Create a Yagi-Uda antenna with a reflector, driven element, and configurable number of directors. Generates wire elements and a discrete … |
| Create an axial-mode helical antenna for circular polarization. Generates helix coil, ground plane, and feed. |
| Create a Vivaldi (tapered slot) antenna on a dielectric substrate. Generates substrate, exponential taper metallisation, and feed. |
| Create a slot antenna in a ground plane. Generates the ground plane with a resonant slot and microstrip feed. |
| Create an Inverted-F antenna (IFA) suitable for mobile devices. Generates ground plane, radiating arm, shorting pin, and feed. |
| Create a Planar Inverted-F Antenna (PIFA) for compact wireless devices. Generates ground plane, top patch, shorting wall, and feed. |
| Create a wideband Archimedean spiral antenna. Generates two spiral arms with a discrete port feed at the center. |
| Create a planar bowtie antenna. Generates two triangular arms with a discrete port at the feed gap. |
| List all available parametric antenna templates with descriptions and typical use cases. No arguments required. |
Antenna arrays (8)
Linear/planar/circular arrays, beam steering, taper.
Tool | What it does |
| Create a linear antenna array by replicating an element along a chosen axis. Uses Transform.Translate to produce copies named Element_1 t… |
| Create a 2D planar antenna array with rectangular or triangular lattice. Replicates an element in X and Y using Transform.Translate. |
| Create a circular antenna array by placing elements at equal angular intervals around a circle of given radius. |
| Compute the array factor analytically for a linear or planar array. Returns AF(theta) in dB, half-power beamwidth, first null beamwidth, … |
| Calculate progressive phase weights to steer the main beam to a specified angle. Returns phase weights and VBA to set port phases in CST. |
| Design amplitude taper weights for sidelobe control. Supports uniform, cosine, Hamming, Hanning, Blackman, Taylor, and Chebyshev window f… |
| Analyse whether grating lobes exist for a given element spacing and maximum scan angle. Returns safe spacing and grating lobe angles. |
| Set up a multi-port S-parameter simulation in CST for mutual coupling extraction between array elements. |
PCB / SI (13)
Stackups, traces, vias, ground planes, Gerber import.
Tool | What it does |
| Create a PCB layer stackup in CST Studio. Generates brick geometry for each layer (signal, ground, power, dielectric) positioned vertical… |
| Create a PCB trace (microstrip, stripline, coplanar waveguide, or grounded CPW) in CST Studio. Optionally calculates trace width from a t… |
| Create a PCB via (through, blind, or buried) in CST Studio. Generates the cylindrical via barrel with specified drill and pad dimensions.… |
| Create a ground or power plane with optional cutouts (split planes, isolation slots) in CST Studio. Generates a solid copper brick and su… |
| Import a Gerber/ODB++/DXF file for PCB analysis in CST Studio. Generates VBA for the CST Gerber import wizard. In offline mode, explains … |
| List predefined PCB stackup templates with complete layer definitions. Includes standard 2/4/6-layer FR-4 and RF-grade Rogers stackups. U… |
| Create a differential pair of PCB traces in CST Studio. Generates two parallel bricks separated by a gap and calculates the differential … |
| Create a detailed PCB via model in CST Studio with parasitic inductance and capacitance estimates. Uses the Goldfarb model for via induct… |
| Create a row (or multiple rows) of vias along a path for isolation or Substrate Integrated Waveguide (SIW) construction. Generates an arr… |
| Create a coplanar waveguide (CPW) to microstrip transition in CST Studio. Generates a tapered geometry that linearly tapers the center co… |
| Calculate electromagnetic coupling between parallel PCB traces. Computes even/odd mode impedances, coupling coefficient, and near-end/far… |
| Create a Substrate Integrated Waveguide (SIW) in CST Studio. Generates top and bottom copper planes with two rows of via fences forming t… |
| Add a parametric edge-launch SMA connector at a board edge: PEC body (default 9.5 x 9.5 x 6 mm) standing off the edge by 'gap', PTFE coax… |
Matching networks (8)
L / Pi / T networks, stubs, quarter-wave, Smith transforms.
Tool | What it does |
| Design an L-section impedance matching network. Computes inductor and capacitor values for matching a source impedance to a load impedanc… |
| Design a Pi-section impedance matching network (C-L-C or L-C-L). Uses two back-to-back L-sections via a virtual resistance for controllab… |
| Design a T-section impedance matching network (L-C-L). Dual of Pi-network, uses two back-to-back L-sections. Pure Python computation. |
| Design a single-stub impedance matching network. Computes the stub length and distance from the load using Smith chart transmission-line … |
| Design a quarter-wave transformer matching network. Supports single and multi-section designs with maximally flat (binomial) or Chebyshev… |
| Generate CST VBA code to create a lumped-element matching network. Each component (inductor, capacitor, resistor) is placed as a CST Lump… |
| Apply a reactive element transformation to an impedance on the Smith chart. Supports series L/C, shunt L/C, and transmission line operati… |
| Calculate microstrip transmission line characteristic impedance from physical dimensions using the Hammerstad-Jensen model with optional … |
Publication figures (1)
IEEE-style 1D result and farfield figures from saved projects (PDF/SVG/PNG).
Tool | What it does |
| Publication-quality (IEEE column, serif, PDF/SVG/PNG) figures of 1D results read offline from a saved .cst via cst.results (no GUI, no so… |
Farfield figures (2)
Polar cuts, heatmaps and 3D patterns with gain/HPBW/F-B metrics.
Tool | What it does |
| Publication-quality farfield figures (IEEE sizes, serif, grayscale-safe): polar dB cuts (E/H-plane, co/cross-pol when Ludwig-3/spherical … |
| Top-view surface-current |J| map(s) in dB with matplotlib (shared scale across panels optional, maximum marked) plus metrics (max A/m a… |
Technical drawings (1)
Dimensioned orthographic views of the model with title block and parameter table.
Tool | What it does |
| Render an academic, dimensioned orthographic technical drawing (third-angle top/front/side views, optional isometric) of the CST model. C… |
VBA escape hatch (3)
Raw VBA execution and built-in VBA object reference.
Tool | What it does |
| Execute raw VBA code in CST Studio Suite (history VBA). DISABLED BY DEFAULT in connected mode: it only runs when the server process has t… |
| Get VBA reference documentation for a CST Studio object. Returns the object description and a list of its common methods and properties. |
| List available CST Studio VBA objects, optionally filtered by category. Returns object names with brief descriptions. |
Available Tools
184 toolscst_add_discrete_portA
Add a discrete (lumped) port between two points. Used for circuit-level excitation with a defined impedance.
Inputs: x1 (required), x2 (required), y1 (required), y2 (required), +5 more.
cst_add_field_monitorA
Add a field monitor at a specific frequency to the CST project. Field monitors must be defined before running a simulation to capture field distributions, far-field patterns, surface currents, or power flow at the desired frequency.
Inputs: frequency (required), monitor_type (required), name.
cst_add_fixpoint_meshA
Add a fixed mesh point at specific coordinates for precise field sampling. Ensures the mesh contains a node exactly at the specified location for accurate field probing.
Inputs: x (required), y (required), z (required), name.
cst_add_floquet_portB
Add a Floquet port for periodic structures such as frequency selective surfaces, metamaterials, and phased arrays.
Inputs: orientation (required), port_number (required), modes.
cst_add_lumped_elementC
Add a lumped R, L, C, or RLC element between two points. Value is in ohms for R, henries for L, farads for C.
Inputs: x1 (required), x2 (required), y1 (required), y2 (required), +5 more.
cst_add_mesh_refinementA
Add local mesh refinement to a specific solid. This creates finer mesh around critical geometry features like feed points, gaps, or thin layers.
Inputs: solid (required), component (required), refinement_factor.
cst_add_multipin_portA
Add a waveguide port with multiple mode monitoring for higher-order mode analysis. Used for multimode waveguides, mode converters, and structures where higher-order propagating modes need to be captured.
Inputs: x_max (required), x_min (required), y_max (required), y_min (required), +5 more.
cst_add_plane_waveB
Add a plane wave excitation source. Defines an incident plane wave with given direction and polarization for scattering / RCS analysis.
Inputs: phi (required), theta (required), polarization (required), e_phi, +1 more.
cst_add_waveguide_portA
Add a waveguide port for S-parameter excitation. Defines a port face on the boundary of the simulation domain for guided-wave excitation. IMPORTANT: The port plane should be at or near the edge of the model geometry. Ground planes and substrates must NOT extend past the port plane in the port's orientation direction, or VBA execution may hang. For microstrip feeds: place the port at the end of the feed line where the ground/substrate terminates. Use Coordinates='Free' for ports not aligned to the bounding box. Valid orientations: xmin/xmax/ymin/ymax/zmin/zmax.
Inputs: x_max (required), x_min (required), y_max (required), y_min (required), +6 more.
cst_analyze_impedanceA
Analyze antenna impedance match quality across frequency bands using S-parameter data. Exports S11 from a completed simulation, computes VSWR and return loss per frequency point, detects resonances, and provides resonance-based design recommendations (e.g. shift resonance up/down, widen bandwidth). Returns per-band worst/best VSWR, match quality classification, nearest resonance info, and actionable design guidance. Read-only — does not modify the model.
Inputs: bands (required), z0, port, sample_frequencies_ghz.
cst_antenna_bowtieB
Create a planar bowtie antenna. Generates two triangular arms with a discrete port at the feed gap.
Inputs: frequency_ghz (required), flare_angle, arm_length_mm.
cst_antenna_dipoleA
Create a half-wave dipole antenna at a target frequency. Generates two wire arms with a discrete port at the feed gap.
Inputs: frequency_ghz (required), wire_radius_mm.
cst_antenna_helixB
Create an axial-mode helical antenna for circular polarization. Generates helix coil, ground plane, and feed.
Inputs: frequency_ghz (required), num_turns, ground_type.
cst_antenna_hornA
Create a pyramidal horn antenna for a target frequency and gain. Generates the waveguide section, flared horn, and waveguide port.
Inputs: frequency_ghz (required), a, b, gain_dbi.
cst_antenna_ifaA
Create an Inverted-F antenna (IFA) suitable for mobile devices. Generates ground plane, radiating arm, shorting pin, and feed.
Inputs: frequency_ghz (required), ground_width_mm, ground_length_mm.
cst_antenna_monopoleA
Create a quarter-wave monopole antenna over a ground plane. Generates a vertical wire element, ground plane, and feed port.
Inputs: frequency_ghz (required), wire_radius_mm, ground_radius_mm.
cst_antenna_patchA
Create a rectangular microstrip patch antenna with calculated dimensions for a target frequency. Supports inset, microstrip, and probe feed types. Generates substrate, ground plane, patch, feed structure, waveguide port, boundaries, and field monitors.
Inputs: frequency_ghz (required), tan_d, epsilon_r, feed_type, +2 more.
cst_antenna_pifaB
Create a Planar Inverted-F Antenna (PIFA) for compact wireless devices. Generates ground plane, top patch, shorting wall, and feed.
Inputs: frequency_ghz (required), patch_width_mm, ground_width_mm, ground_length_mm.
cst_antenna_slotA
Create a slot antenna in a ground plane. Generates the ground plane with a resonant slot and microstrip feed.
Inputs: frequency_ghz (required), slot_width_mm.
cst_antenna_spiralA
Create a wideband Archimedean spiral antenna. Generates two spiral arms with a discrete port feed at the center.
Inputs: freq_low_ghz (required), freq_high_ghz (required), num_turns.
cst_antenna_vivaldiA
Create a Vivaldi (tapered slot) antenna on a dielectric substrate. Generates substrate, exponential taper metallisation, and feed.
Inputs: frequency_ghz (required), epsilon_r, substrate_height_mm, taper_length_factor.
cst_antenna_yagiB
Create a Yagi-Uda antenna with a reflector, driven element, and configurable number of directors. Generates wire elements and a discrete port feed.
Inputs: frequency_ghz (required), num_directors.
cst_array_beam_steeringA
Calculate progressive phase weights to steer the main beam to a specified angle. Returns phase weights and VBA to set port phases in CST.
Inputs: spacing_mm (required), num_elements (required), frequency_ghz (required), scan_theta_deg (required), +1 more.
cst_array_circularA
Create a circular antenna array by placing elements at equal angular intervals around a circle of given radius.
Inputs: radius_mm (required), num_elements (required), frequency_ghz (required), element_component.
cst_array_compute_factorA
Compute the array factor analytically for a linear or planar array. Returns AF(theta) in dB, half-power beamwidth, first null beamwidth, peak sidelobe level, and directivity.
Inputs: num_elements (required), spacing_wavelengths (required), array_type, scan_angle_deg, +1 more.
cst_array_grating_lobe_analysisB
Analyse whether grating lobes exist for a given element spacing and maximum scan angle. Returns safe spacing and grating lobe angles.
Inputs: spacing_wavelengths (required), max_scan_angle_deg.
cst_array_linearB
Create a linear antenna array by replicating an element along a chosen axis. Uses Transform.Translate to produce copies named Element_1 through Element_N.
Inputs: spacing_mm (required), num_elements (required), frequency_ghz (required), axis, +1 more.
cst_array_mutual_couplingA
Set up a multi-port S-parameter simulation in CST for mutual coupling extraction between array elements.
Inputs: num_ports (required), port_numbers.
cst_array_planarB
Create a 2D planar antenna array with rectangular or triangular lattice. Replicates an element in X and Y using Transform.Translate.
Inputs: num_x (required), num_y (required), spacing_x_mm (required), spacing_y_mm (required), +3 more.
cst_array_taper_designB
Design amplitude taper weights for sidelobe control. Supports uniform, cosine, Hamming, Hanning, Blackman, Taylor, and Chebyshev window functions.
Inputs: taper_type (required), num_elements (required), sidelobe_level_db.
cst_assign_materialB
Assign a material to an existing solid in CST Studio. The solid is specified as 'Component:SolidName'.
Inputs: solid (required), material (required).
cst_boolean_addC
Unite/add two solids together. The result replaces solid1 with the combined volume of both shapes.
Inputs: solid1 (required), solid2 (required).
cst_boolean_insertB
Insert solid2 into solid1. Solid2 is embedded within solid1, maintaining both material regions at the overlap.
Inputs: solid1 (required), solid2 (required).
cst_boolean_intersectA
Intersect two solids. Only the overlapping volume is kept, replacing solid1. Solid2 is deleted.
Inputs: solid1 (required), solid2 (required).
cst_boolean_subtractB
Subtract solid2 from solid1. The overlapping volume of solid2 is removed from solid1. Solid2 is deleted.
Inputs: solid1 (required), solid2 (required).
cst_close_projectA
Close the currently open CST project and release its resources.
Inputs: no named parameters.
cst_configure_eigenmode_advancedA
Advanced eigenmode solver configuration for higher-order modes. Use this for waveguide mode analysis, cavity resonator design, and filter characterization where fine control over mode count, frequency targeting, and solver order is needed.
Inputs: accuracy, num_modes, solver_order, frequency_estimate_ghz.
cst_configure_eigenmode_solverA
Configure the eigenmode solver. Computes resonant frequencies and field distributions of cavity structures. Used for filter design, resonator characterization, and Q-factor extraction.
Inputs: f_min, accuracy, number_of_modes.
cst_configure_frequency_domain_solverA
Configure the frequency domain solver. Best for narrowband problems, resonant structures, and when field distributions at specific frequencies are needed. Supports interpolated, discrete, and general-purpose sweep types.
Inputs: f_max (required), f_min (required), samples, accuracy, +1 more.
cst_configure_ie_solver_advancedA
Advanced Integral Equation solver configuration for electrically large structures. Provides control over preconditioner, MLFMM acceleration, and low-frequency stabilization for installed antenna performance and large-platform RCS analysis.
Inputs: mlfmm, accuracy, max_iterations, preconditioner, +1 more.
cst_configure_integral_equation_solverA
Configure the integral equation (IE) solver. Best for electrically large, open-boundary problems like antenna placement on vehicles, RCS computation, and EMC/EMI analysis where volume meshing would be impractical.
Inputs: accuracy, max_iterations.
cst_configure_multilayer_solverB
Configure the solver for planar multilayer structures. Optimised for antenna-on-PCB, frequency selective surfaces (FSS), and radome analysis using the frequency domain solver with multilayer-specific settings.
Inputs: f_max (required), f_min (required), sweep_type, num_samples.
cst_configure_time_domain_solverA
Configure the time domain (transient) solver. This is CST's flagship solver for broadband simulations — it excites the structure with a pulse and computes S-parameters, fields, and farfield across the entire frequency range in a single run.
Inputs: accuracy, max_time_steps, excitation_type, fixed_impedance, +2 more.
cst_connectA
Explicitly attach to a running CST Design Environment or start one. Disabled mode never connects.
Inputs: no named parameters.
cst_connection_statusA
Get the current CST Studio connection status, including mode (connected/offline), CST availability, version, and work directory.
Inputs: no named parameters.
cst_constrained_optimizerB
Single-objective optimization with explicit inequality constraints. Example: minimize S11 subject to gain > 8 dBi and bandwidth > 100 MHz.
Inputs: objective (required), parameters (required), constraints (required), method, +1 more.
cst_create_analytical_curveB
Create a parametric analytical curve in CST Studio using expressions of parameter t.
Inputs: name (required), t_max (required), t_min (required), x_expr (required), +2 more.
cst_create_anisotropic_materialA
Create an anisotropic material with per-axis permittivity, permeability, and loss tangent values. Used for crystals, metamaterials, and composite substrates.
Inputs: mu_x (required), mu_y (required), mu_z (required), name (required), +6 more.
cst_create_brickC
Create a rectangular brick (box) in CST Studio.
Inputs: name (required), x_max (required), x_min (required), y_max (required), +5 more.
cst_create_cole_cole_materialA
Create a Cole-Cole dispersive material. Generalisation of the Debye model with a distribution parameter alpha (0-1) that broadens the relaxation spectrum. Used for biological tissues, soil, and broadband absorbers.
Inputs: name (required), alpha (required), epsilon_inf (required), delta_epsilon (required), +1 more.
cst_create_coneB
Create a cone or truncated cone in CST Studio.
Inputs: axis (required), name (required), component (required), range_max (required), +7 more.
cst_create_cylinderB
Create a cylinder in CST Studio. Use inner_radius=0 for a solid cylinder.
Inputs: axis (required), name (required), component (required), range_max (required), +7 more.
cst_create_debye_materialA
Create a frequency-dependent dielectric material using the Debye relaxation model. Models polar dielectrics where permittivity decreases with frequency: eps(w) = eps_inf + delta_eps/(1 + jw*tau). Used for biological tissues, water, polymers, and soil.
Inputs: name (required), epsilon_inf (required), delta_epsilon (required), relaxation_time_ps (required), +2 more.
cst_create_drude_materialA
Create a Drude metal model material for plasmonic and metamaterial simulations. Models free-electron metals: eps(w) = 1 - wp^2 / (w^2 + jgammaw). Used for gold, silver, aluminium in optical/THz frequency ranges.
Inputs: name (required), plasma_freq_ghz (required), collision_freq_ghz (required).
cst_create_ecylinderC
Create an elliptical cylinder in CST Studio.
Inputs: axis (required), name (required), x_radius (required), y_radius (required), +7 more.
cst_create_extrudeB
Extrude a 2D polygon profile into a 3D solid in CST Studio.
Inputs: name (required), height (required), points (required), component (required), +1 more.
cst_create_face_from_curvesB
Create a planar face from one or more closed curves in CST Studio.
Inputs: name (required), component (required), curve_names (required).
cst_create_ferrite_materialA
Create a ferrite material with gyrotropic permeability tensor (Polder model). Essential for circulators, isolators, and phase shifters. The Polder tensor describes the anisotropic magnetic response of a magnetised ferrite (Pozar Ch. 9.1).
Inputs: name (required), epsilon_r (required), linewidth_oe (required), saturation_magnetization_ka_m (required), +2 more.
cst_create_loftB
Create a lofted solid between two or more 2D profiles in CST Studio.
Inputs: name (required), profiles (required), component (required), material.
cst_create_lorentz_materialA
Create a Lorentz oscillator dispersive material. Models resonant dielectric behaviour near absorption bands: eps(w) = eps_inf + delta_eps * w0^2 / (w0^2 - w^2 + jgammaw). Used for glass, crystals, and optical materials.
Inputs: name (required), epsilon_inf (required), delta_epsilon (required), damping_freq_ghz (required), +1 more.
cst_create_lossy_metalA
Create a lossy metal material in CST Studio. Lossy metals model finite conductivity skin-effect losses, essential for accurate loss calculations in connectors, waveguides, and PCB traces.
Inputs: name (required), conductivity (required), mu.
cst_create_materialB
Create a new material with electromagnetic properties in CST Studio. Specify relative permittivity (epsilon), relative permeability (mu), electric and magnetic loss tangents, and conductivity.
Inputs: name (required), mu, color_b, color_g, +6 more.
cst_create_polygon3dC
Create a 3D polygon curve in CST Studio.
Inputs: name (required), points (required).
cst_create_polygon_extrudeB
Create a polygon and extrude it along an axis in CST Studio. Convenience tool combining polygon profile creation and extrusion.
Inputs: name (required), height (required), points (required), component (required), +2 more.
cst_create_projectA
Create a new CST Studio Suite project file. In connected mode the project is created directly; in offline mode a VBA script is returned for manual execution.
Inputs: path (required), project_type.
cst_create_sphereB
Create a sphere in CST Studio.
Inputs: name (required), radius (required), component (required), center_x, +4 more.
cst_create_temperature_dependent_materialA
Create a material with temperature-dependent electromagnetic properties. Specify base properties and temperature coefficients for thermal-electromagnetic co-simulation.
Inputs: name (required), epsilon_r (required), conductivity (required), reference_temp_c, +2 more.
cst_create_torusB
Create a torus in CST Studio.
Inputs: axis (required), name (required), component (required), inner_radius (required), +5 more.
cst_create_wireB
Create a bondwire / wire between two points in CST Studio.
Inputs: name (required), end_x (required), end_y (required), end_z (required), +5 more.
cst_delete_materialB
Delete a material from the current CST project.
Inputs: name (required).
cst_delete_parameterA
Delete a design parameter from the CST project. The parameter must not be referenced by other parameters or geometry.
Inputs: name (required).
cst_delete_portB
Delete a port by its port number.
Inputs: port_number (required).
cst_delete_resultsA
Delete simulation results from the current CST project. This prevents the 'Results May Get Incompatible With Model' dialog that blocks automation when modifying a model with existing results. Call before making parameter or geometry changes on a project that has been solved.
Inputs: no named parameters.
cst_design_patch_onlyB
Calculate microstrip patch dimensions only (offline, no CST). Sadece boyut hesabı — CST gerekmez.
Inputs: frequency_ghz (required), epsilon_r, feed_type, height_mm, +1 more.
cst_disconnectA
Detach this MCP session without closing CST, projects, or a running solver.
Inputs: no named parameters.
cst_discover_farfield_monitorsB
Discover farfield monitors from the project Result folder and tree-path heuristics. Uzak alan monitörlerini disk + path sezgisiyle listeler.
Inputs: no named parameters.
cst_dismiss_dialogsA
Find and dismiss any visible CST dialog windows (error popups, 'Results Incompatible' dialogs, solver warnings). Returns the title and text content of each dialog before dismissing it. Use this to unblock CST when a modal dialog is preventing further automation. Uses Win32 API on Windows.
Inputs: read_only.
cst_evaluate_antennaA
Evaluate current antenna simulation results against performance goals. Exports S-parameter data and checks VSWR (or return loss) against per-band targets. Read-only — does not modify the model. Returns pass/fail per band, worst VSWR, and detected resonances.
Inputs: bands (required), port.
cst_execute_vbaA
Execute raw VBA code in CST Studio Suite. The code is validated for safety (shell access, file I/O, and external process execution are blocked). In connected mode the code runs directly; in offline mode the validated script is returned for manual execution.
Inputs: code (required).
cst_export_cadA
Export the current CST model (or a specific component) to a CAD format. Supports STL, SAT/ACIS, STEP, IGES, OBJ, and NASTRAN.
Inputs: format (required), file_path (required), component.
cst_export_farfieldA
Export far-field radiation pattern data to a file. Requires a completed simulation with far-field monitor results.
Inputs: file_path (required), frequency (required), format.
cst_export_projectA
Export the current CST project or its geometry to another format such as STL, STEP, IGES, SAT, OBJ, or NASTRAN.
Inputs: path (required), format (required).
cst_export_resultA
Export a simulation result to a file (CSV, Touchstone, or text). Specify the result tree path and desired output format. Useful for post-processing results in external tools like MATLAB or Python.
Inputs: output_file (required), result_path (required), format.
cst_export_structure_viewsA
Export structure screenshots (perspective/xy/xz/yz) via Plot.ExportImage. Yapı görünüm görsellerini dışa aktarır. Connected mode required.
Inputs: views, width, height, out_dir.
cst_export_touchstoneA
Export S-parameter simulation results to a Touchstone file. Requires a completed simulation with S-parameter data.
Inputs: file_path (required), format.
cst_get_axial_ratioA
Extract axial ratio for circularly polarized antennas from a completed CST simulation. Axial ratio (AR) indicates the quality of circular polarization: AR=0 dB is perfect CP, AR<3 dB is acceptable. Can plot AR vs angle or vs frequency.
Inputs: frequency (required), mode, phi_cut, theta_cut.
cst_get_bandwidthA
Calculate impedance bandwidth from S-parameter results. Finds the frequency range where S11 (or VSWR) meets the specified threshold. Returns center frequency, bandwidth in MHz, and fractional bandwidth percentage.
Inputs: port, run_id, criterion, max_points, +1 more.
cst_get_cross_polarizationA
Extract cross-polarization level and cross-polarization discrimination (XPD) from a completed CST simulation. Supports Ludwig-3, Ludwig-2, and circular polarization definitions. Requires a farfield monitor at the specified frequency.
Inputs: frequency (required), definition.
cst_get_current_distributionA
Extract volume current distribution from a completed CST simulation at a specific frequency. Complements surface current extraction by providing current density inside dielectric or lossy volumes. Requires a current density monitor at the specified frequency.
Inputs: frequency (required), component.
cst_get_efficiencyA
Get antenna radiation efficiency from a completed CST simulation at a specific frequency. Returns total efficiency (including mismatch), radiation efficiency (excluding mismatch), and mismatch loss in dB.
Inputs: frequency (required).
cst_get_efficiency_breakdownA
Get a detailed efficiency breakdown with loss budget from a completed CST simulation. Returns radiation efficiency, total efficiency, and individual loss contributions (mismatch, conductor, dielectric). Useful for identifying dominant loss mechanisms in antenna designs.
Inputs: frequency (required).
cst_get_farfieldA
Get far-field radiation pattern results from a completed CST simulation at a specific frequency. Returns gain, directivity, radiation efficiency, and beam widths. Requires a farfield monitor at the specified frequency.
Inputs: frequency (required), monitor_name.
cst_get_farfield_metricsA
Read antenna metrics after a solve: S11 + radiation/total efficiency from 1D Results, plus max realized gain via official FarfieldPlot.GetMax (SelectTreeItem Farfields\farfield (f=X) [1] → Plot → GetMax). Does NOT use ASCIIExportSummary (that API spams Message on CST 2026). Solve sonrası S11, verimlilik ve max gain; GUI farfield ile uyumlu.
Inputs: monitor_name, frequency_ghz, try_farfield_plot.
cst_get_gainA
Get antenna gain at a specific frequency from a completed CST simulation. Returns peak gain in dBi and the direction (theta, phi) of maximum gain. Requires a farfield monitor at the specified frequency.
Inputs: frequency (required).
cst_get_group_delayA
Compute group delay from S-parameter phase for a port pair. Group delay is defined as tau = -d(phase)/d(2pif) and represents the signal propagation delay through the device. Useful for UWB antenna and filter characterization.
Inputs: run_id, port_in, port_out, max_points.
cst_get_impedanceA
Get input impedance (Z-parameters) for a port from a completed CST simulation. Returns real and imaginary impedance vs frequency. Useful for matching network design and feed optimization.
Inputs: port.
cst_get_material_infoA
Get electromagnetic properties of a material from the bundled database. Returns epsilon_r, mu_r, conductivity, loss tangent, and usage notes.
Inputs: name (required).
cst_get_mesh_infoB
Get current mesh statistics and settings. In connected mode this queries the live mesh data; in offline mode it returns the VBA to retrieve mesh info.
Inputs: no named parameters.
cst_get_mesh_qualityA
Extract mesh quality metrics including total cells, aspect ratios, and cells per wavelength. In connected mode this queries actual mesh statistics; in offline mode it describes what metrics would be returned.
Inputs: no named parameters.
cst_get_parameterA
Get the current value of a design parameter. Returns both the stored expression and the evaluated numeric value.
Inputs: name (required).
cst_get_pattern_cutA
Extract an E-plane, H-plane, or custom radiation pattern cut from a completed CST simulation at a specific frequency. Returns gain vs angle for the selected plane. Requires a farfield monitor at the specified frequency.
Inputs: frequency (required), plane, phi_cut, theta_cut.
cst_get_radiation_pattern_3dA
Export full 3D radiation pattern data from a completed CST simulation at a specific frequency. Returns gain values over the full sphere in spherical or Cartesian coordinates. Useful for antenna pattern visualization and integration with external tools. Requires a farfield monitor at the specified frequency.
Inputs: frequency (required), coordinate, resolution_deg.
cst_get_result_summaryA
Get a summary of all key simulation results from a completed CST simulation. Returns an overview of S-parameters, gain, efficiency, and impedance. Useful for a quick design evaluation without querying each result type individually.
Inputs: no named parameters.
cst_get_simulation_statusA
Read whether a CST simulation is running and return any solver-run metadata exposed by the CST Python API. This does not show a dialog or change the simulation.
Inputs: timeout_s.
cst_get_smith_chart_dataA
Extract Smith chart formatted impedance data from a completed CST simulation. Computes normalized impedance from S11 reflection coefficient: Z = Z0*(1+S11)/(1-S11). Returns real and imaginary parts of the normalized impedance for Smith chart plotting.
Inputs: z0, port, run_id, max_points.
cst_get_solver_infoA
Get current solver configuration and status. In connected mode this queries the active solver settings; in offline mode it describes expected parameters.
Inputs: no named parameters.
cst_get_s_parameter_phaseA
Extract S-parameter phase response from a completed CST simulation. Returns the phase of the specified S-parameter vs frequency. Optionally unwraps the phase to remove 360-degree discontinuities. Useful for group delay analysis and phase-matching designs.
Inputs: run_id, unwrap, port_in, port_out, +1 more.
cst_get_s_parametersA
Extract S-parameter results from a completed CST simulation. Returns S-parameter data (magnitude, phase, real/imaginary) for the specified port pair. In connected mode reads directly from the result tree; in offline mode returns VBA scripts and explains the CST result tree structure.
Inputs: format, run_id, port_in, port_out, +1 more.
cst_get_surface_currentA
Extract surface current density distribution from a completed CST simulation at a specific frequency. Useful for understanding current flow on antenna structures and identifying hot spots. Requires a surface current monitor at the specified frequency.
Inputs: frequency (required), component.
cst_get_time_domain_signalA
Extract time-domain port signal waveforms from a completed CST time-domain simulation. Returns incident, reflected, or transmitted signal vs time. Useful for UWB pulse analysis, time-domain reflectometry, and transient response evaluation.
Inputs: port, port_out, signal_type.
cst_get_vswrA
Get Voltage Standing Wave Ratio (VSWR) for a port from a completed CST simulation. VSWR indicates impedance matching quality: 1.0 is perfect match, <2.0 is generally acceptable. Can also be computed from S11: VSWR = (1+|S11|)/(1-|S11|).
Inputs: port, run_id, max_points.
cst_impedance_smith_transformA
Apply a reactive element transformation to an impedance on the Smith chart. Supports series L/C, shunt L/C, and transmission line operations. Returns transformed impedance, reflection coefficient, and VSWR. Pure Python computation.
Inputs: value (required), operation (required), z_in_imag (required), z_in_real (required), +2 more.
cst_import_cadA
Import a CAD file into CST Studio. Supports STEP (.stp/.step), IGES (.igs/.iges), STL (.stl), SAT/ACIS (.sat), DXF (.dxf), and OBJ (.obj) formats.
Inputs: format (required), file_path (required), component.
cst_import_touchstoneB
Import a Touchstone S-parameter file (.s1p, .s2p, .snp) into CST Studio for use as a reference or circuit element.
Inputs: file_path (required), port_number.
cst_list_antenna_templatesA
List all available parametric antenna templates with descriptions and typical use cases. No arguments required.
Inputs: no named parameters.
cst_list_ferrite_materialsA
List available ferrite materials from the bundled database. Returns name, permittivity, saturation magnetisation, linewidth, loss tangent, maximum frequency, and usage notes for each ferrite.
Inputs: no named parameters.
cst_list_materialsA
List available materials from the bundled material database. Optionally filter by category: 'metals', 'dielectrics', or 'substrates'. Returns name, key EM properties, and usage notes for each material.
Inputs: category.
cst_list_parametersA
List all design parameters in the current CST project with their names, expressions, and evaluated numeric values.
Inputs: no named parameters.
cst_list_portsA
List all ports defined in the current CST project. Returns VBA to query port information, or a description in offline mode.
Inputs: no named parameters.
cst_list_resultsA
List all available results in the CST result tree. Optionally specify a subtree path to narrow the listing. Useful for discovering what simulation results are available before extracting specific data.
Inputs: tree_path.
cst_list_saved_resultsA
List exact result tree paths and run IDs from a saved, unpacked, completed .cst file using cst.results. No connection or CST GUI is required. Do not use a file currently being solved.
Inputs: project_path (required), limit, offset, contains.
cst_list_vba_objectsA
List available CST Studio VBA objects, optionally filtered by category. Returns object names with brief descriptions.
Inputs: category.
cst_load_materialA
Load a material from the CST material library by its library name. The material is added to the project under the given name.
Inputs: name (required), library_name (required).
cst_matching_create_lumpedB
Generate CST VBA code to create a lumped-element matching network. Each component (inductor, capacitor, resistor) is placed as a CST LumpedElement with specified series/shunt connection.
Inputs: components (required), frequency_ghz (required), port_impedance.
cst_matching_l_networkA
Design an L-section impedance matching network. Computes inductor and capacitor values for matching a source impedance to a load impedance at a given frequency. Supports lowpass and highpass topologies. Pure Python computation — no CST connection needed.
Inputs: z_load_real (required), frequency_ghz (required), z_source_real (required), topology, +2 more.
cst_matching_microstrip_impedanceB
Calculate microstrip transmission line characteristic impedance from physical dimensions using the Hammerstad-Jensen model with optional Kirschning-Jansen frequency dispersion correction. Pure Python computation.
Inputs: width_mm (required), epsilon_r (required), height_mm (required), thickness_mm, +1 more.
cst_matching_pi_networkA
Design a Pi-section impedance matching network (C-L-C or L-C-L). Uses two back-to-back L-sections via a virtual resistance for controllable Q factor. Pure Python computation.
Inputs: z_load_real (required), frequency_ghz (required), z_source_real (required), q_factor, +2 more.
cst_matching_quarter_waveA
Design a quarter-wave transformer matching network. Supports single and multi-section designs with maximally flat (binomial) or Chebyshev impedance profiles. Pure Python computation.
Inputs: z_load (required), z_source (required), frequency_ghz (required), design, +1 more.
cst_matching_stubA
Design a single-stub impedance matching network. Computes the stub length and distance from the load using Smith chart transmission-line matching. Pure Python computation.
Inputs: z_load_real (required), frequency_ghz (required), z0, stub_type, +1 more.
cst_matching_t_networkA
Design a T-section impedance matching network (L-C-L). Dual of Pi-network, uses two back-to-back L-sections. Pure Python computation.
Inputs: z_load_real (required), frequency_ghz (required), z_source_real (required), q_factor, +2 more.
cst_multi_objective_optimizerA
Set up a multi-objective optimization with weighted goals and optional constraints. Uses a weighted sum of goals with an evaluation cap; this is not a Pareto-front search. Configuration only; start explicitly.
Inputs: goals (required), parameters (required), method, constraints, +1 more.
cst_open_projectA
Open an existing CST Studio Suite project. In connected mode the project is opened in the running instance; in offline mode a reference is stored for subsequent operations.
Inputs: path (required).
cst_optimizerB
Set up an optimization in CST Studio. Define a goal (minimize, maximize, or target a specific value for a result), specify which parameters to vary with their bounds, and choose an optimization algorithm.
Inputs: goal_type (required), parameters (required), result_path (required), method, +2 more.
cst_parameter_interpolationA
Interpolate results between parameter sweep data points to estimate performance at a specific parameter value without running a new simulation.
Inputs: parameter (required), result_path (required), target_value (required).
cst_parameter_sweepC
Set up a parameter sweep in CST Studio. The sweep runs the simulation multiple times, varying the specified parameter across a range of values.
Inputs: stop (required), start (required), steps (required), parameter (required), +1 more.
cst_pause_simulationB
Pause a currently running CST simulation. The simulation can be resumed later with cst_resume_simulation.
Inputs: timeout_s.
cst_pcb_calculate_couplingA
Calculate electromagnetic coupling between parallel PCB traces. Computes even/odd mode impedances, coupling coefficient, and near-end/far-end crosstalk estimates using coupled microstrip formulas. Pure calculation — no VBA or CST geometry is generated.
Inputs: epsilon_r (required), height_mm (required), frequency_ghz (required), separation_mm (required), +2 more.
cst_pcb_cpw_transitionA
Create a coplanar waveguide (CPW) to microstrip transition in CST Studio. Generates a tapered geometry that linearly tapers the center conductor width and gap over the transition length. Calculates CPW and microstrip impedances.
Inputs: name (required), layer (required), height_mm (required), cpw_gap_mm (required), +6 more.
cst_pcb_create_ground_planeA
Create a ground or power plane with optional cutouts (split planes, isolation slots) in CST Studio. Generates a solid copper brick and subtracts cutout regions.
Inputs: layer (required), width_mm (required), length_mm (required), cutouts, +2 more.
cst_pcb_create_stackupA
Create a PCB layer stackup in CST Studio. Generates brick geometry for each layer (signal, ground, power, dielectric) positioned vertically with correct materials. Returns total thickness and layer positions.
Inputs: layers (required), board_width_mm (required), board_length_mm (required).
cst_pcb_create_traceA
Create a PCB trace (microstrip, stripline, coplanar waveguide, or grounded CPW) in CST Studio. Optionally calculates trace width from a target impedance using Hammerstad-Jensen (microstrip) or Cohn (stripline) formulas.
Inputs: layer (required), length_mm (required), trace_type (required), x_start, +8 more.
cst_pcb_create_viaA
Create a PCB via (through, blind, or buried) in CST Studio. Generates the cylindrical via barrel with specified drill and pad dimensions. Pad and antipad diameters are validated and reported but the geometry covers the barrel only; add pads separately if needed.
Inputs: x (required), y (required), end_z (required), start_z (required), +7 more.
cst_pcb_differential_pairB
Create a differential pair of PCB traces in CST Studio. Generates two parallel bricks separated by a gap and calculates the differential impedance using coupled-line theory (Zdiff = 2Z0(1-k)).
Inputs: name (required), layer (required), gap_mm (required), length_mm (required), +7 more.
cst_pcb_import_gerberB
Import a Gerber/ODB++/DXF file for PCB analysis in CST Studio. Generates VBA for the CST Gerber import wizard. In offline mode, explains the import process and required settings.
Inputs: file_path (required), layer_name (required), file_type.
cst_pcb_list_stackup_templatesA
List predefined PCB stackup templates with complete layer definitions. Includes standard 2/4/6-layer FR-4 and RF-grade Rogers stackups. Use the returned layer data directly with cst_pcb_create_stackup.
Inputs: filter.
cst_pcb_siw_waveguideB
Create a Substrate Integrated Waveguide (SIW) in CST Studio. Generates top and bottom copper planes with two rows of via fences forming the waveguide sidewalls. Calculates effective width, cutoff frequency, and guided wavelength using Cassivi et al. formulas.
Inputs: name (required), layer (required), width_mm (required), length_mm (required), +7 more.
cst_pcb_via_fenceA
Create a row (or multiple rows) of vias along a path for isolation or Substrate Integrated Waveguide (SIW) construction. Generates an array of cylinders from start to end point with specified spacing.
Inputs: name (required), x_end (required), y_end (required), x_start (required), +7 more.
cst_pcb_via_modelB
Create a detailed PCB via model in CST Studio with parasitic inductance and capacitance estimates. Uses the Goldfarb model for via inductance and a simplified capacitance formula.
Inputs: x (required), y (required), name (required), end_layer (required), +8 more.
cst_project_infoA
Get information about the currently open CST project, including connection mode, project path, and status.
Inputs: no named parameters.
cst_project_treeB
List items in the CST project navigation tree. Optionally specify a subtree path such as 'Components', 'Materials', 'Ports', 'Monitors', or 'Results'.
Inputs: tree_path.
cst_read_helpA
Read a paginated official local CST help topic returned by cst_search_help. No GUI or solver.
Inputs: topic (required), offset, max_chars.
cst_read_project_logA
Read solver log files and project status information from the current CST project. Returns solver running state and the contents of the most recent log file. Useful for diagnosing solver errors, checking simulation progress, and understanding what happened during a failed run.
Inputs: no named parameters.
cst_read_saved_resultA
Read a complete complex 1D curve by exact tree path and run_id from a completed saved .cst, without opening CST. Raw real/imag are preserved; format adds derived values. max_points=0 returns all samples; otherwise returns an explicitly sampled preview.
Inputs: tree_path (required), project_path (required), format, run_id, +1 more.
cst_refine_antennaA
Run an automated Nelder-Mead optimization loop to tune CST design parameters toward VSWR goals across specified frequency bands. Each iteration sets parameters, runs the solver, exports S11, and evaluates against targets. Uses silent VBA execution to avoid history bloat. Applies the best parameters permanently at the end. Connected mode only — requires a live CST session with a solvable project.
Inputs: bands (required), parameters (required), port, max_iterations.
cst_resume_simulationB
Resume a previously paused CST simulation. Use after cst_pause_simulation to continue from where it stopped.
Inputs: timeout_s.
cst_run_simulationA
Start a CST simulation with the current solver settings. This is a blocking call that waits for the simulation to complete. Use cst_run_simulation_async for long-running simulations.
Inputs: timeout_s, solver_type.
cst_run_simulation_asyncA
Start a CST simulation asynchronously (non-blocking). The simulation launches and control returns immediately. Use cst_get_simulation_status to monitor progress.
Inputs: timeout_s, solver_type.
cst_save_projectA
Save the currently open CST project. Optionally provide a new path to 'Save As'.
Inputs: path.
cst_search_helpA
Search the installed official CST Python/VBA help by topic filename. Does not start CST. Read the matching help before constructing API calls.
Inputs: query (required), limit.
cst_sensitivity_analysisA
Set up a one-at-a-time sensitivity analysis to rank parameters by their impact on a result. Varies each parameter individually while keeping others at nominal values.
Inputs: parameters (required), result_path (required).
cst_set_adaptive_meshA
Configure adaptive mesh refinement. When enabled, the solver runs multiple passes, refining the mesh in regions of high field gradient until the result converges within the specified threshold.
Inputs: enabled, threshold, max_passes.
cst_set_backgroundA
Set the background material properties of the simulation domain. The background fills all space not occupied by defined solids.
Inputs: mu, epsilon, material.
cst_set_boundaryB
Set boundary conditions for the simulation domain. Each face of the bounding box can be assigned an independent boundary type (open, electric, magnetic, periodic, etc.).
Inputs: x_max (required), x_min (required), y_max (required), y_min (required), +2 more.
cst_set_floquet_port_advancedA
Configure advanced Floquet port settings for periodic structures. Controls the number of Floquet modes and scan angle for phased array element simulation and oblique incidence analysis.
Inputs: num_modes, scan_phi_deg, scan_theta_deg.
cst_set_frequency_rangeB
Set the simulation frequency range in GHz. This determines the bandwidth over which the solver computes results.
Inputs: f_max (required), f_min (required).
cst_set_mesh_densityA
Set global mesh density parameters controlling automatic mesh generation. Higher cells_per_wavelength gives finer mesh and better accuracy at the cost of longer simulation time.
Inputs: min_cells, ratio_limit, cells_per_wavelength.
cst_set_mesh_typeA
Set the mesh type for the simulation. Hexahedral is used for time-domain, Tetrahedral for frequency-domain, Surface for integral-equation, and Hexahedral TLM for TLM solver.
Inputs: mesh_type (required).
cst_set_parameterA
Set or create a design parameter in CST Studio. Parameters can hold numeric values or string expressions referencing other parameters.
Inputs: name (required), value (required), description.
cst_set_periodic_boundaryB
Configure periodic boundary conditions with optional phase shift for unit cell simulation. Sets X and Y boundaries to periodic and configures the phase shift for infinite array, FSS, and metasurface analysis.
Inputs: phase_x_deg, phase_y_deg.
cst_set_pml_propertiesA
Configure PML (Perfectly Matched Layer) absorbing boundary properties. Controls the number of absorbing layers and the target reflection level for fine-tuning radiation boundary accuracy.
Inputs: num_layers, reflection_level_db.
cst_set_symmetryA
Set symmetry planes to reduce computation time. Each axis can be assigned electric or magnetic symmetry, or none. Requires the model geometry and excitation to be compatible with the chosen symmetry.
Inputs: x_plane, y_plane, z_plane.
cst_start_dialog_watcherA
Start a background thread that automatically detects and dismisses CST dialog windows as they appear. Essential for long-running operations like optimization loops where dialogs would otherwise block execution. The watcher logs every dialog it dismisses — retrieve the log with cst_stop_dialog_watcher.
Inputs: no named parameters.
cst_stop_dialog_watcherA
Stop the background dialog watcher and return its log of all dialogs that were auto-dismissed. Use after completing an operation that required the watcher.
Inputs: no named parameters.
cst_stop_simulationA
Stop and abort a running CST simulation. Unlike pause, a stopped simulation cannot be resumed — it must be restarted from the beginning.
Inputs: timeout_s.
cst_transform_mirrorB
Mirror a solid across a plane (xy, xz, or yz). An optional center point can be specified.
Inputs: plane (required), solid (required), copy, center_x, +2 more.
cst_transform_rotateA
Rotate a solid by a given angle around an axis (x, y, or z). An optional center point can be specified.
Inputs: axis (required), angle (required), solid (required), copy, +3 more.
cst_transform_scaleB
Scale a solid by independent factors along each axis. An optional center point can be specified.
Inputs: solid (required), copy, scale_x, scale_y, +4 more.
cst_transform_translateA
Translate (move) a solid by a displacement vector (dx, dy, dz). Optionally create a translated copy.
Inputs: dx (required), dy (required), dz (required), solid (required), +1 more.
cst_vba_helpA
Get VBA reference documentation for a CST Studio object. Returns the object description and a list of its common methods and properties.
Inputs: object_name (required).
cst_workflow_design_reportA
ONE-SHOT design package after modeling/simulation: project status, parameters/dimensions, S-parameters (+metrics), best-effort farfield export, and structure view images. Each section fails soft — you still get partial results. Tasarım bittikten sonra boyutlar, S11, uzak alan ve görselleri tek çağrıda toplar.
Inputs: port, out_dir, max_points, frequency_ghz, +4 more.
cst_workflow_patch_antennaA
END-TO-END / Uçtan uca: size a rectangular microstrip patch, build substrate/ground/patch/feed, frequency, open BCs, waveguide port, farfield monitor. Does not connect to or start CST; call cst_connect first for live execution, otherwise it returns offline VBA. Does NOT run the solver. Simülasyon çalıştırmaz — next: cst_workflow_run_and_s11 or cst_run_simulation.
Inputs: frequency_ghz (required), epsilon_r, feed_type, height_mm, +3 more.
cst_workflow_run_and_s11C
Run solver and return structured S11/Sij with metrics (min dB, bandwidth). Solver çalıştırır ve S parametrelerini metriklerle döner.
Inputs: port_in, port_out, timeout_s, max_points.
cst_workflow_simulate_and_reportB
Run the solver, then immediately build a design report (S-params + views + optional farfield). Simülasyonu çalıştırıp rapor paketini üretir.
Inputs: port, out_dir, timeout_s, max_points, +3 more.
cst_yield_analysisB
Set up a Monte Carlo yield analysis to estimate manufacturing yield. Randomly varies parameters according to their tolerances and evaluates pass/fail criteria.
Inputs: parameters (required), pass_criteria (required), num_samples.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 184 tools
Most tools have clearly distinct purposes across geometry, simulation, results, and antenna/PCB domains. A few near-overlaps exist (e.g., cst_get_farfield vs cst_get_radiation_pattern_3d, cst_run_simulation vs cst_workflow_run_and_s11) but descriptions sufficiently differentiate them.
All tools share the cst_ prefix, but the pattern mixes verb-based names (cst_create_brick, cst_get_s_parameters) with category-based names (cst_antenna_patch, cst_pcb_create_trace, cst_matching_l_network). Within each category naming is consistent, but globally it is a mixed convention.
184 tools is extreme over-proliferation. Even the lower bound of 'too many' (25+) is far exceeded, creating an overwhelming surface that increases selection difficulty and maintenance overhead.
The domain coverage is remarkably thorough: project management, geometry creation, materials, ports, boundaries, mesh, solvers, simulation control, results extraction, antenna templates, arrays, PCB design, matching networks, and workflows. No significant gaps are apparent for the stated purpose.
Maintenance
Related MCP Connectors
A comprehensive Model Context Protocol (MCP) server that enables AI assistants to interact with yo…
A comprehensive Model Context Protocol (MCP) server that enables AI assistants to control Unreal E…
MCP server for OpenMM — exposes market data, account, trading, and strategy tools to AI agents
QuLab MCP remote server (Streamable HTTP) for computational science and lab tools.
Related MCP Servers
- AlicenseBqualityDmaintenanceMCP Server for COMSOL Multiphysics simulation automation via AI agents.782MIT
- AlicenseBqualityDmaintenanceEnables AI agents to control CST Studio Suite for 3D electromagnetic simulation, antenna design, and schematic-based field-circuit co-simulation through 177 MCP tools.10013AGPL 3.0
- FlicenseNot gradedqualityDmaintenanceMCP server for automating ANSYS HFSS simulations, enabling persistent connections, modeling, simulation setup, and S-parameter extraction through AI assistants.1-
- AlicenseNot gradedqualityCmaintenanceTurns CST Studio Suite into an AI-controllable electromagnetic design lab, enabling conversational THz metamaterial absorber design, unit-cell automation, Floquet port control, batch solve with checkpoint-resume, and surrogate-model predictions.2MIT