Metadata-Version: 2.4
Name: ansys-mapdl-mcp
Version: 0.2.1
Summary: Model Context Protocol (MCP) server for Ansys MAPDL through PyMAPDL
Keywords: ansys,mapdl,pymapdl,mcp,model-context-protocol,ai,assistant,finite-element-analysis
Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
Requires-Python: >=3.10,<4
Description-Content-Type: text/markdown
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
License-File: LICENSE
Requires-Dist: ansys-common-mcp>=0.1.0
Requires-Dist: ansys-mapdl-core>=0.72.0
Requires-Dist: ansys-sphinx-theme[changelog]==1.8.2 ; extra == "doc"
Requires-Dist: numpydoc==1.10.0 ; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints==3.1.0 ; extra == "doc"
Requires-Dist: sphinx-notfound-page==1.1.0 ; extra == "doc"
Requires-Dist: sphinx==8.2.3 ; extra == "doc"
Requires-Dist: sphinxcontrib-video==0.4.2 ; extra == "doc"
Requires-Dist: ansys-common-mcp==0.3.0 ; extra == "tests"
Requires-Dist: ansys-mapdl-core==0.73.1 ; extra == "tests"
Requires-Dist: pytest-asyncio==1.4.0 ; extra == "tests"
Requires-Dist: pytest-cov==7.1.0 ; extra == "tests"
Requires-Dist: pytest-mock==3.15.1 ; extra == "tests"
Requires-Dist: pytest==9.0.3 ; extra == "tests"
Project-URL: Documentation, https://mapdl-mcp.docs.pyansys.com
Project-URL: Homepage, https://github.com/ansys/pymapdl-mcp
Project-URL: Issues, https://github.com/ansys/pymapdl-mcp/issues
Project-URL: Repository, https://github.com/ansys/pymapdl-mcp
Provides-Extra: doc
Provides-Extra: tests

# PyMAPDL MCP Server

[![PyAnsys](https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5+OQgMJ/0AqCqXGQMEBAwBEKQj5gGDjQsA80UeCDscxrD4YhGsgABEELnC5zAwAu6ACKQDAQzNBFwAAVdgFEAnfDiQAATyIBaAFgCbkAI5DQwAVGAYkAMA4gHgg2AC+AAgQIABggagAqyAD4AACkR7cEdcEBQOPjIvAEtRDoAbYLANQAZGsBEAFeBwCsAY0HgGCAAEQTaDj7xQABItJ+S3DsQAAAABJRU5ErkJggg==)](https://docs.pyansys.com/)
[![Python](https://img.shields.io/badge/Python-3.10%2B-blue)](https://www.python.org/)
[![Apache](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

PyMAPDL MCP Server provides a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/)
server that enables AI assistants to interact with Ansys MAPDL (Mechanical APDL) through
[PyMAPDL](https://mapdl.docs.pyansys.com/). This server enables natural language interaction with MAPDL for finite element analysis tasks.

## Overview

Key features:

- **Dynamic connection management**: Launch new MAPDL instances, connect to existing ones, or disconnect on demand
- **Execute MAPDL commands**: Run single commands or batch multiple commands for efficiency
- **Custom Python execution**: Run arbitrary Python and PyMAPDL code in a persistent session
- **Advanced visualization**: Create custom ``matplotlib`` and ``pyvista`` plots, or capture MAPDL native plots
- **Workflow guidance**: Access comprehensive context and best practices for all phases of MAPDL simulations
- **Flexible deployment**: Works with MAPDL running locally, remotely, or in Docker containers

<p align="center">

https://github.com/user-attachments/assets/99b68fbd-2308-46a0-aa44-9684ae7400b7


<b>Video 1: PyMAPDL MCP Demo</b>

</p>


<video controls width="720" src="_static/videos/PyMAPDL-MCP-demo.mp4">
  Your browser does not support the video tag.
</video>


## Installation

### For users

Install the latest release with:

```bash
pip install ansys-mapdl-mcp
```

Or run directly without installing using [`uvx`](https://docs.astral.sh/uv/):

```bash
uvx --from git+https://github.com/ansys/pymapdl-mcp ansys-mapdl-mcp
```

### For developers

```bash
git clone https://github.com/ansys/pymapdl-mcp.git
cd pymapdl-mcp
pip install -e .[tests]
```

## Usage

For step-by-step setup instructions for VS Code, Claude Code, Claude Desktop, and other
MCP-compatible clients, see the
[IDE and Client Configuration](https://mapdl-mcp.docs.pyansys.com/getting_started/ide_configuration.html)
page in the documentation.

## License

This project is licensed under the Apache 2.0 license agreement. See the [LICENSE](./LICENSE) file for details.

## Resources

- [PyMAPDL-MCP documentation](https://mapdl-mcp.docs.pyansys.com)
- [PyMAPDL Documentation](https://mapdl.docs.pyansys.com/)
- [Model Context Protocol](https://modelcontextprotocol.io/)
- [FastMCP Documentation](https://github.com/jlowin/fastmcp)
- [Ansys MAPDL](https://www.ansys.com/products/structures/ansys-mechanical-apdl)
- [Repository's Issues page](https://github.com/ansys/pymapdl-mcp/issues)
- [Repository's Discussions page](https://github.com/ansys/pymapdl-mcp/discussions)

For general PyAnsys questions, email [pyansys.core@ansys.com](mailto:pyansys.core@ansys.com).

