.. title:: Welcome to PyMechanical-MCP

.. meta::
   :keywords: pymechanical, mechanical, mcp, ai, llm, simulation, finite elements, python
   :description: Welcome to PyMechanical-MCP documentation.

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

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

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

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

.. vale off

.. vale off

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

.. vale on

.. vale on

**What do you want to do?**

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

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

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

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

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

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

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

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

        Access complete reference documentation for all MCP tools.

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

        Review tool availability, capability groups, and workflow examples.

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

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

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

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

    .. grid-item-card:: :fa:`external-link-alt` Access PyMechanical documentation
        :link: https://mechanical.docs.pyansys.com/
        :link-type: url

        Access the PyMechanical documentation for product-level details.

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

        Ask questions or report issues on the GitHub Discussions page.

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

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