PyMechanical-MCP provides a Model Context Protocol (MCP) server that enables AI assistants to interact with Ansys Mechanical through PyMechanical. Use natural language to set up, solve, and postprocess structural, thermal, and multiphysics simulations.
Overview
Key features:
- Manage Mechanical sessions by launching new instances or connecting to existing ones
- Run Mechanical scripting workflows through the Mechanical API
- Execute custom Python and PyMechanical code in a persistent session
- Export results, capture screenshots, and create custom plots
- Retrieve built-in guidance for common Mechanical workflow steps
- Work with local, remote, or containerized Mechanical deployments
Tool surface
You can use 21 tools exposed by the server, grouped as follows:
| Group | Tools |
|---|---|
| Connection and lifecycle | check_mechanical_status, check_mechanical_installed, launch_mechanical, connect_to_mechanical, disconnect_from_mechanical, list_mechanical_instances |
| File and project management | list_files, upload_file, download_file, clear_mechanical, save_project, open_project |
| Mechanical scripting and solve | run_python_script, solve_analysis, get_model_info, export_results |
| Visualization and diagnostics | screenshot, create_custom_plot, get_mechanical_logs |
| Persistent Python execution | run_python_code |
| Workflow guidance | get_guidelines_for |
The server also exposes an MCP resource, files://mechanical/working_directory, that
returns the working directory of the connected Mechanical instance.
Installation
For users
Install the latest release with:
pip install ansys-mechanical-mcp
Or run directly without installing by using uvx:
uvx --index-strategy unsafe-best-match --from git+https://github.com/ansys/pymechanical-mcp ansys-mechanical-mcp
For developers
git clone https://github.com/ansys/pymechanical-mcp.git
cd pymechanical-mcp
pip install -e ".[dev]"
Usage
For step-by-step setup instructions for VS Code, Claude Code, Claude Desktop, and other MCP-compatible clients, see IDE and client configuration in the documentation.
For launch and connect workflows, including GUI and batch mode behavior, see Quick start.
Configuration
Use STDIO for local MCP clients. Use HTTP transport for remote access in trusted networks or behind infrastructure that provides authentication and TLS.
Run with default STDIO transport:
ansys-mechanical-mcp
Run with HTTP transport:
ansys-mechanical-mcp --transport http --http-host 127.0.0.1 --http-port 8080
Common configuration options:
| Option | Description |
|---|---|
--transport |
MCP transport type: stdio or http |
--ip, --port |
Mechanical connection target for connect_on_startup or defaults |
--connect-on-startup |
Connect to Mechanical when the MCP server starts |
--transport-mode |
gRPC mode: auto, insecure, mtls, wnua |
--certs-dir |
Directory containing mTLS certificates (ca.crt, client.crt, client.key) |
--cors-origins |
Comma-separated allowed origins for HTTP transport |
Environment variables:
| Variable | Description |
|---|---|
PYMECHANICAL_TRANSPORT_MODE |
Default gRPC transport mode when --transport-mode is not set |
ANSYS_GRPC_CERTIFICATES |
Default certificate directory when --certs-dir is not set |
PYMECHANICAL_IP, PYMECHANICAL_PORT |
Docker connection defaults used by connection and discovery tools |
License
This project is licensed under the Apache 2.0 license agreement. See the LICENSE file for details.
Resources
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ansys_mechanical_mcp-0.2.0.tar.gz.
File metadata
- Download URL: ansys_mechanical_mcp-0.2.0.tar.gz
- Upload date:
- Size: 46.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
95bad05ef2844981a2660a724bfdc8491f926c14d5046efa11e06aa8300d6012
|
|
| MD5 |
7e4a8372518d53a3d518906f1dd5f037
|
|
| BLAKE2b-256 |
1418b11405b3c0ae4a0523cb8096a156fd28f373abae7db8886804d326310aa9
|
Provenance
The following attestation bundles were made for ansys_mechanical_mcp-0.2.0.tar.gz:
Publisher:
ci.yml on ansys/pymechanical-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ansys_mechanical_mcp-0.2.0.tar.gz -
Subject digest:
95bad05ef2844981a2660a724bfdc8491f926c14d5046efa11e06aa8300d6012 - Sigstore transparency entry: 2448795584
- Sigstore integration time:
-
Permalink:
ansys/pymechanical-mcp@64f407897039e910efc608b4256cb6be49856495 -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/ansys
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@64f407897039e910efc608b4256cb6be49856495 -
Trigger Event:
push
-
Statement type:
File details
Details for the file ansys_mechanical_mcp-0.2.0-py3-none-any.whl.
File metadata
- Download URL: ansys_mechanical_mcp-0.2.0-py3-none-any.whl
- Upload date:
- Size: 51.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
834a3d0e732cc29eec39bb65578f06cd99a6aceb525f013cc17fb82271330c25
|
|
| MD5 |
017cf09dd0ceed3f4084b122df145eed
|
|
| BLAKE2b-256 |
f75b398140dff248ca8c941411db6fe7aa3859be2e3d09cab64034231a342049
|
Provenance
The following attestation bundles were made for ansys_mechanical_mcp-0.2.0-py3-none-any.whl:
Publisher:
ci.yml on ansys/pymechanical-mcp
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ansys_mechanical_mcp-0.2.0-py3-none-any.whl -
Subject digest:
834a3d0e732cc29eec39bb65578f06cd99a6aceb525f013cc17fb82271330c25 - Sigstore transparency entry: 2448795869
- Sigstore integration time:
-
Permalink:
ansys/pymechanical-mcp@64f407897039e910efc608b4256cb6be49856495 -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/ansys
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@64f407897039e910efc608b4256cb6be49856495 -
Trigger Event:
push
-
Statement type:
