ansys/pyaedt-mcp

PyAEDT-MCP is an MCP (Model Context Protocol) server for Ansys Electronics Desktop (AEDT). It gives you reliable AEDT tools and a persistent PyAEDT-backed Python session for tasks that do not fit a dedicated tool.

What PyAEDT-MCP does

PyAEDT-MCP supports this runtime loop:

1. Check whether AEDT is installed or already reachable.
2. Launch AEDT or connect to an existing gRPC session.
3. Open projects, create designs, run analyses, inspect the model, and export results.
4. Use run_python_code or run_python_script for custom PyAEDT work.

Supported AEDT applications include HFSS, Maxwell 2D/3D, Q2D, Q3D, Icepak, Circuit, TwinBuilder, Mechanical, EMIT, RMXprt, and HFSS 3D Layout.

Install

Run without cloning

Install uv and Git first. Git is required because uvx downloads and runs PyAEDT-MCP directly from this repository without cloning it. Python 3.13 is recommended; --python 3.13 selects it explicitly and lets uv download it if needed.

uvx --python 3.13 --from git+https://github.com/ansys/pyaedt-mcp.git ansys-aedt-mcp

Install locally

Use a Python 3.13 or later environment (3.13 recommended).

pip install git+https://github.com/ansys/pyaedt-mcp.git

Or use uv:

uv pip install git+https://github.com/ansys/pyaedt-mcp.git

Windows installer

Windows releases include PyAEDT-MCP-Installer-windows.exe:

• Installs the desktop manager into C:\Program Files\ANSYS Inc\PyAEDT MCP.
• Adds a Start Menu entry and registers an uninstaller in Windows Installed Apps.
• On first use, creates %APPDATA%\.pyaedt_mcp\.venv and uses bundled CPython 3.13 and uv to install ansys-aedt-mcp from PyPI.
• Supports offline installation from the Settings tab. Each install or update prompts you to select a Python 3.13 wheelhouse ZIP and installs only from that archive, without querying package indexes.
• Saves the offline installation selection in %APPDATA%\.pyaedt_mcp\settings.yaml.

Opening the executable provides setup, HTTP server controls, AEDT options, and stdio or HTTP profiles for Copilot/VS Code, Claude, Cursor, Codex, and OpenCode.

Install for development

git clone https://github.com/ansys/pyaedt-mcp.git
cd pyaedt-mcp
pip install -e .
pre-commit install

Or use uv:

git clone https://github.com/ansys/pyaedt-mcp.git
cd pyaedt-mcp
uv pip install -e .
pre-commit install

Requirements

• Python 3.13 or later (3.13 recommended)
• Git to install or run PyAEDT-MCP directly from this repository with uv
• AEDT 2022 R2 or later for gRPC workflows
• A local AEDT installation or a reachable remote AEDT gRPC endpoint

Quick start

1. Start AEDT in gRPC mode when connecting to an existing session:

   "C:\Program Files\ANSYS Inc\v261\AnsysEM\ansysedt.exe" -grpcsrv 50051
   

   Or, just launch AEDT normally. It automatically starts a gRPC server.

   PyAEDT-MCP can also launch AEDT for you if it is not already running.

2. Choose an MCP transport:

   • stdio is the simplest option for one local client. The client starts PyAEDT-MCP automatically through uvx or from a cloned repository’s virtual environment.
   • HTTP connects the client to a separately running server. Use it for local development, Docker, or a remote server.

   Start an HTTP server through uvx without cloning:

   uvx --python 3.13 --index-strategy unsafe-best-match \
     --from git+https://github.com/ansys/pyaedt-mcp.git ansys-aedt-mcp \
     --transport http --http-host 127.0.0.1 --http-port 8080
   

3. Point an MCP client at the server:

   Use the IDE and client configuration guide for short HTTP and stdio configurations for VS Code/Copilot, Claude, OpenCode, and Codex, plus local virtual-environment instructions.

Tool reference

For information on the available tools, see Tools and capabilities in the PyAEDT-MCP documentation.

How the repository is organized

The core package is in src\ansys\aedt\mcp:

Other top-level folders include:

• doc\source: Sphinx documentation
• tests: Unit and integration coverage
• docker: Container assets
• examples: Sample assets used by the project

Development workflow

To contribute, see Contribute in the PyAEDT-MCP documentation.

Add a new tool

Most tools require a live AEDT connection. Tag those tools with REQUIRES_AEDT_TAG in src\ansys\aedt\mcp\tools.py so they can be hidden until the session exists when dynamic discovery is enabled.

For more information, see Add a new tool in the PyAEDT-MCP documentation.

License

Apache 2.0 license. See LICENSE.

Related projects

• PyAEDT
• PyAEDT documentation
• FastMCP documentation
• Model Context Protocol documentation