.. _ref_index:

.. image:: _static/images/logo_minimal_dark.png
    :alt: PyAEDT-MCP logo
    :class: only-dark
    :align: center
    :width: 700

.. image:: _static/images/logo_minimal_light.png
    :alt: PyAEDT-MCP logo
    :class: only-light
    :align: center
    :width: 700

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

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

PyAEDT-MCP is an MCP (Model Context Protocol) server for Ansys Electronics Desktop (AEDT).
You can use it to access a focused set of tools and a persistent
`PyAEDT <https://github.com/ansys/pyaedt>`__-backed Python session built with
`FastMCP <https://github.com/PrefectHQ/fastmcp>`_.
You can also configure PyAEDT-MCP to connect automatically to a running AEDT instance when it starts.

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

    .. grid-item-card:: :fa:`info-circle` Learn about PyAEDT-MCP
        :link: user_guide/overview
        :link-type: doc

        Learn what PyAEDT-MCP is, how it works, and why to use it.

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

        Install PyAEDT-MCP, start the server, and connect to AEDT.

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

        Report bugs, suggest features, improve the documentation, or submit
        a pull request.

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

        Ask questions or report issues on the GitHub Discussions page.

Setup and advanced tips
-----------------------

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

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

        Set up PyAEDT-MCP with Claude Code, Visual Studio Code, Claude Desktop,
        or any other MCP-compatible client.

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

        Review the full toolset, what is available before and after
        connection, and the timeout tiers.

    .. grid-item-card:: :fa:`diagram-project` Workflow examples
        :link: user_guide/workflows
        :link-type: doc

        Follow practical end-to-end AEDT workflows using the PyAEDT-MCP toolset.

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

        Learn recommended practices for session management, scripting, data
        handling, visualization, and workflow design.