Welcome to PyLumerical-MCP
==========================

.. meta::
   :keywords: pylumerical, lumerical, mcp, ai, llm, fdtd, mode, device, interconnect, photonics, python
   :description: Welcome to PyLumerical-MCP documentation.

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

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


PyLumerical-MCP is a Model Context Protocol (MCP) server that lets AI agents drive Ansys Lumerical
tools using `PyLumerical <https://lumerical.docs.pyansys.com/>`__.

Documentation
-------------

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

   .. grid-item-card::
      :link: getting_started/index
      :link-type: doc

      :fa:`person-running` Getting started
      ^^^

      Set up PyLumerical-MCP and connect it to your IDE.

   .. grid-item-card::
      :link: user_guide/index
      :link-type: doc

      :fa:`book` User guide
      ^^^
      Learn how to use PyLumerical-MCP effectively.

   .. grid-item-card::
      :link: api/index
      :link-type: doc

      :fa:`book-open-reader` API reference
      ^^^
      Access reference for the PyLumerical-MCP API and its available tools.

   .. grid-item-card::
      :link: examples/index
      :link-type: doc

      :fa:`code` Examples
      ^^^
      Explore example prompts for using PyLumerical-MCP to drive Lumerical tools.

   .. grid-item-card::
      :link: contributing
      :link-type: doc

      :fa:`users` Contribute
      ^^^
      Learn how to contribute to PyLumerical-MCP.


Related resources
-----------------

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

   .. grid-item-card::
      :link: https://lumerical.docs.pyansys.com/
      :link-type: url

      :fa:`book` PyLumerical documentation
      ^^^

      Access PyLumerical documentation.