PyCFX-MCP logo PyCFX-MCP logo

Welcome to the PyCFX-MCP documentation! Use PyCFX-MCP, an MCP (Model Context Protocol) server, to connect your AI assistant to Ansys CFX workflows through PyCFX.

What do you want to do?

Learn about PyCFX-MCP

Learn what PyCFX-MCP is, how it works, when to use it, and how MCP clients interact with CFX through a compact tool surface.

Overview
Get started quickly

Install PyCFX-MCP and run your first MCP server over STDIO or Streamable HTTP.

Installation
Configure your IDE

Set up PyCFX-MCP with Visual Studio Code or another MCP-compatible client.

IDE and client configuration
Explore available tools

Review tools for sessions, workflows, model context, code generation, validation, and execution.

Tools and capabilities
Learn best practices

Follow practical guidance for safe session management, routed workflow actions, and bounded model-context gathering.

Best practices
Browse code examples

Explore usage examples and learn how to implement custom MCP tools for CFX-oriented workflows.

Examples
Use the API reference

Access complete API reference documentation for PyCFX-MCP.

API reference
Find help or report issues

Ask questions or report issues on the GitHub Issues page.

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

Contribute to PyCFX-MCP by reporting bugs, writing code, or improving the documentation.

Contributing