.. title:: Welcome to PyFluent-MCP

.. meta::
   :keywords: ansys.fluent.mcp, pyfluent, fluent, mcp, ai, llm, cfd, simulation, python
   :description: Welcome to PyFluent-MCP (ansys.fluent.mcp) documentation.

.. toctree::
   :hidden:
   :maxdepth: 3

   getting_started/index
   user_guide/index
   api/index
   examples/index
   changelog

.. image:: ../source/_static/logo-dark.png
   :class: only-dark
   :width: 800
   :alt: PyFluent-MCP logo
   :align: center

.. image:: ../source/_static/logo-light.png
   :class: only-light
   :width: 800
   :alt: PyFluent-MCP logo
   :align: center

.. vale off

**Welcome to the PyFluent-MCP documentation!** PyFluent-MCP (``ansys.fluent.mcp``) is a
Model Context Protocol (MCP) server that provides seamless integration between AI
assistants and Ansys Fluent through PyFluent_.

**What do you want to do?**

.. vale on

.. grid:: 2 2 3 3
   :gutter: 1 2 3 3
   :padding: 1 2 3 3

   .. grid-item-card:: :fa:`info-circle` Learn what PyFluent-MCP is
      :link: user_guide/overview
      :link-type: doc

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

   .. grid-item-card:: :fa:`rocket` Get started quickly
      :link: getting_started/installation
      :link-type: doc

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

   .. grid-item-card:: :fa:`cogs` Configure your IDE
      :link: getting_started/ide_configuration
      :link-type: doc

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

   .. grid-item-card:: :fa:`tools` Explore available tools
      :link: user_guide/tools_and_capabilities
      :link-type: doc

      Discover all 22 MCP tools available for
      Fluent solver setup, settings inspection,
      code generation, and diagnostics.

   .. grid-item-card:: :fa:`book` Learn best practices
      :link: user_guide/best_practices
      :link-type: doc

      Discover best practices for using PyFluent-MCP
      effectively, including session management,
      the discover-generate-validate-execute loop,
      and workflow design patterns.

   .. grid-item-card:: :fa:`code` Browse code examples
      :link: examples/index
      :link-type: doc

      Explore practical examples including solver
      setup workflows, custom domain tools, and
      offline API discovery.

   .. grid-item-card:: :fa:`book-open-reader` Use the API reference
      :link: api/index
      :link-type: doc

      Access complete API reference documentation for PyFluent-MCP.

   .. grid-item-card:: :fa:`question` Find help or report issues
      :link: https://github.com/ansys/pyfluent-mcp/issues
      :link-type: url

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

   .. grid-item-card:: :fa:`users` Contribute to the project
      :link: getting_started/contribution
      :link-type: doc

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