.. title:: Welcome to PyMAPDL-MCP

.. meta::
   :keywords: pymapdl, mapdl, mcp, ai, llm, simulation, finite elements, python
   :description: Welcome to PyMAPDL-MCP documentation.

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

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


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

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


.. vale off

**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?**

.. 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 PyMAPDL-MCP is
        :link: user_guide/overview
        :link-type: doc

        Discover what PyMAPDL-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 PyMAPDL-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 PyMAPDL-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 the MCP tools available for
        MAPDL control, Python execution, visualization,
        and workflow guidance.

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

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

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

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

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

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

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

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

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

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