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

What do you want to do?

Learn what PyMechanical-MCP is

Discover what PyMechanical-MCP is, how it works, and why you should use it.

Overview

Get started quickly

Install PyMechanical-MCP and get your first MCP server running.

Installation

Configure your IDE

Set up PyMechanical-MCP with Claude Code, Visual Studio Code, or Claude Desktop.

IDE and client configuration

Use the API reference

Access complete reference documentation for all MCP tools.

API reference

Explore available tools

Review tool availability, capability groups, and workflow examples.

Tools and capabilities

Learn best practices

Discover practical workflow recommendations to avoid common setup and solve issues.

Best practices

Browse examples

Explore practical Mechanical workflows that can be adapted for MCP-assisted analysis.

Examples

Access PyMechanical documentation

Access the PyMechanical documentation for product-level details.

https://mechanical.docs.pyansys.com/

Find help or report issues

Ask questions or report issues on the GitHub Discussions page.

https://github.com/ansys/pymechanical-mcp/discussions

Contribute to the project

Learn how to contribute code, documentation, and examples to PyMechanical-MCP.

Contribute