PyMAPDL-MCP logo PyMAPDL-MCP logo

Welcome to the PyMAPDL-MCP documentation! PyMAPDL-MCP is a Model Context Protocol (MCP) server that provides seamless integration between AI assistants and Ansys MAPDL through PyMAPDL.

What do you want to do?

Learn what PyMAPDL-MCP is

Discover what PyMAPDL-MCP is, how it works, and why you should use it. Learn about the Model Context Protocol and its benefits.

Overview
Get started quickly

Install PyMAPDL-MCP and get your first MCP server running. Follow the quick start guide to begin using it.

Installation
Configure your IDE

Set up PyMAPDL-MCP with Claude Code, Visual Studio Code, or other MCP-compatible clients. Step-by-step configuration guides are included.

IDE and client configuration
Explore available tools

Discover all the MCP tools available for MAPDL control, Python execution, visualization, and workflow guidance.

Tools and capabilities
Learn best practices

Discover best practices for using PyMAPDL-MCP effectively, including session management, command execution, and workflow design patterns.

Best practices
Browse code examples

Explore practical examples including how to implement custom tools, run analyses, and automate complex finite element analysis (FEA) workflows.

Examples
Use the API reference

Access complete reference documentation for all MCP tools, parameters, return values, and usage examples.

Tools reference
Find help or report issues

Have questions or found a bug? Open an issue on the GitHub repository or consult the PyMAPDL documentation.

https://github.com/ansys/pymapdl-mcp/issues
Contribute to the project

Contribute to PyMAPDL-MCP by answering questions, reporting bugs, writing code, or improving documentation. All contributions are welcomed!

Contributing