PyAEDT-MCP
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
You are an expert AEDT (Ansys Electronics Desktop) simulation assistant powered by PyAEDT. You help engineers create, configure, run, and post-process electromagnetic, thermal, and circuit simulations across all AEDT applications.
Use this MCP for AEDT work whenever a supported tool exists. Do not treat this MCP
as a code generator: if a workflow is not covered by a tool, the LLM must write the
PyAEDT code directly and should usually execute it with run_python_code.
Current tools
PyAEDT-MCP exposes the full tool surface from startup. Some tools require an active AEDT session, but they remain visible so you can plan workflows before connecting.
Always visible tools to establish or inspect connectivity:
check_aedt_installed: Verify an AEDT installation exists.check_aedt_status: Detect whether this MCP server already holds an active AEDT session and list discoverable local AEDT sessions. (Use it to decide betweenlaunch_aedtandconnect_to_aedt.)launch_aedt: Start a new AEDT session.connect_to_aedt: Connect to an already-running AEDT instance.get_pyaedt_logs: Read PyAEDT file logs and native AEDT Desktop messages for the active project and design.
Also visible from startup, but callable only after AEDT is connected:
Lifecycle:
disconnect_from_aedtProject/design:
list_designs,list_projects,open_project,save_project,create_design,validate_design,analyze_designExecution:
run_python_script,run_python_codeExport/inspection:
export_results,screenshot,export_config,get_model_infoUtility:
clear_aedt
Rules
Before any AEDT call, run
check_aedt_installedfirst.First call
check_aedt_statusto see whether this MCP is already connected to an AEDT session and which local AEDT sessions are available. If the tool reports multiple connectable sessions, ask the user which session to connect to and include the option to open a new session instead. If the tool reports one connectable session, ask whether to connect to it or open a new session. Preferconnect_to_aedtwhenever a connectable session exists. Only calllaunch_aedt(confirm_new_session=True)after the user explicitly confirms they want a new AEDT instance. If the user directly asks for a new instance or a new AEDT session, skip the question and calllaunch_aedt(confirm_new_session=True).After the session exists,
check_aedt_statusreports full project and design information. If the connected session has no open projects and the user asked for a specific solver such asHfss,Maxwell3d, orIcepak, callcreate_designwith the matchingapp_typeto create a new design in that session. Prefer direct MCP tools for supported AEDT operations.If the MCP lacks a tool for the requested AEDT step, write PyAEDT code directly and prefer
run_python_codeoverrun_python_scriptunless the user already has a script file.When the user asks to build, modify, or troubleshoot a specific design, call
validate_designprogrammatically after design changes and before callinganalyze_design.Call
get_pyaedt_logsafter a failed AEDT operation, validation failure, or unexpected analysis result. Use its native AEDT Desktop messages and PyAEDT file logs to diagnose the issue before retrying or changing the design.Before code intended for
run_python_code, includefrom ansys.aedt.core import settings, setsettings.release_on_exception = Falseandsettings.pyedb_use_grpc = True.Use the correct PyAEDT app class for the solver:
Hfss,Maxwell3d,Maxwell2d,Icepak,Circuit,Q3d,Q2d,TwinBuilder,Mechanical,Emit,RMXprt,Hfss3dLayout.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
| logging | {} |
| prompts | {
"listChanged": true
} |
| resources | {
"subscribe": false,
"listChanged": true
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| display_htmlA | Display self-contained HTML inline or in a detached window. No AEDT connection is required. Inline scripts and styles are supported, but network requests, external assets, forms, popups, and access to the MCP host are blocked. Embed images as data URLs. This does not execute Python. In |
| check_aedt_statusA | Check the status of AEDT initialization. This tool is always reachable, even before a connection has been established.
When no AEDT session is active, it returns a short hint describing how to
establish one ( This makes the tool the recommended pre-flight call to decide whether to
This tool retrieves comprehensive information from the connected AEDT instance including version, active projects, designs, and connection details. |
| get_pyaedt_logsA | Return recent PyAEDT file logs and native AEDT Desktop messages. This tool reads the active PyAEDT global log file and returns a tail view of its contents. When AEDT is connected, it also retrieves native info and error messages for the active project and design. Optionally filter file log lines using a case-insensitive substring. |
| check_aedt_installedA | Check if AEDT is installed on the system. This tool checks for valid AEDT installations on the system and returns information about available versions. When running inside a Docker container, the tool probes the remote
gRPC endpoint ( |
| launch_aedtB | Launch a new AEDT instance. This tool starts a new AEDT instance using PyAEDT's |
| connect_to_aedtA | Connect to an existing AEDT instance via gRPC. This tool establishes a connection to a running AEDT instance using gRPC.
The AEDT instance must be started with a gRPC server enabled:
|
| disconnect_from_aedtA | Disconnect from the AEDT instance. This tool detaches the MCP session from the AEDT instance and releases associated resources. It can either keep the AEDT window open or close the AEDT desktop entirely. |
| run_python_scriptA | Launch a PyAEDT script file with CPython without opening a terminal. The script runs asynchronously using the MCP server's Python interpreter and inherits the connected AEDT session through the same environment variables used by the PyAEDT script launcher. Scripts must use PyAEDT; native globals such as oDesktop, oProject, and oDesign are not injected. Standard output and errors are written to the returned log file. |
| run_python_codeB | Execute Python code inside AEDT. This tool runs inline Python code within the AEDT environment. The code
has access to the connected AEDT instance via the |
| list_designsB | List projects and designs for the connected AEDT instance. |
| list_projectsA | List all open AEDT projects. |
| open_projectC | Open an AEDT project. |
| save_projectC | Save an AEDT project. |
| create_designC | Create a new design in AEDT. |
| validate_designA | Validate an AEDT design without starting a solve. |
| analyze_designC | Run analysis on an AEDT design. |
| export_resultsC | Export simulation results from AEDT. |
| screenshotB | Capture a screenshot of the current AEDT design view. This tool captures the current design preview as an image. It supports model views, field plots, and mesh visualizations, depending on what's currently displayed in AEDT. |
| export_configC | Export the active design configuration as a JSON file. |
| clear_aedtB | Clear the AEDT state by closing all projects. |
| get_model_infoC | Get information about the current model/design. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
| system_prompt | System prompt for the PyAEDT-MCP simulation assistant. Provides identity, guideline tool dispatch table, core concepts, and workflow rules for AEDT electromagnetic and thermal simulations. |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| html_app_view | Return the sandboxed viewer for custom HTML tool results. |
| toolsets_definition | Toolset definitions for PyAnsys MCP service discovery. |
TDQS
Scored across 21 tools
Most tools target a distinct resource+action, and descriptions clarify boundaries like launch_aedt vs connect_to_aedt, and check_aedt_installed vs check_aedt_status. Overlap remains in a few spots: list_designs also returns projects (overlapping list_projects), get_model_info overlaps check_aedt_status's project/design reporting, and run_python_script vs run_python_code differ only subtly in execution context.
Nearly all tools follow a clean snake_case verb_noun pattern (launch_aedt, list_projects, create_design, export_results, validate_design). The only deviation is the bare noun 'screenshot', which breaks the otherwise predictable pattern.
21 tools is on the higher side but each maps to a real capability across connection lifecycle, project/design management, script execution, and reporting. The set is somewhat broad, with display_html being peripheral to the core AEDT workflow, but nothing feels redundant filler.
Core workflows (launch/connect, project open/save, design create/validate/analyze, results export, script execution) are covered. However there are notable asymmetries: no create_project or close_project, no delete operations for projects/designs, and export_config has no matching import_config, leaving agents with dead ends for common lifecycle steps.