Contribute#

You can contribute to PyAEDT-MCP in several ways:

  • Answer questions on the PyAEDT-MCP Discussions page.

  • Report bugs or request features on the PyAEDT-MCP Issues page.

  • Submit pull requests with bug fixes, new features, or documentation improvements.

Before contributing, read Contributing and Coding style in the PyAnsys developer’s guide. To generate useful release notes, follow the guidelines in Branch-naming conventions and Commit-naming conventions.

Answer discussions#

Answering questions on the PyAEDT-MCP Discussions page is the easiest way to contribute. Only a GitHub account is required. Engaging with discussions deepens your understanding of the project and helps other users who are facing similar issues, making the repository more welcoming and inclusive.

Post issues#

Use the PyAEDT-MCP Issues page to report bugs, suggest improvements, or request features.

When possible, use these issue templates:

  • 🐞 Bug, problem, or error: File a bug report.

  • 📖 Documentation issue: Suggest modifications needed to the documentation.

  • 🎓 Adding an example: Propose a new example for the library.

  • 💡 New feature: Propose a new capability.

If your issue does not fit into any existing category, click Blank issue.

Contribute code or documentation#

  1. Clone the repository and install in editable mode with development dependencies:

    git clone https://github.com/ansys/pyaedt-mcp.git
cd pyaedt-mcp
pip install -e .
pre-commit install

  2. Run tests:

    pytest -q

    Note

    Pull requests are accepted only when code coverage is greater than 80%.

  3. Run linters:

    pre-commit run --all-files

  4. Build the documentation:

    python -m sphinx -W -b html doc/source doc/_build/html

Write clear API reference documentation#

PyAEDT-MCP API reference documentation is generated automatically during Sphinx builds.

  • AutoAPI extension: ansys_sphinx_theme.extension.autoapi (configured in doc/source/conf.py)

  • Source package: src/ansys/aedt/mcp

  • Entry page: API reference

When you add or rename modules, classes, or functions under src/ansys/aedt/mcp, rebuild the documentation to generate fresh API pages:

python -m sphinx -W -b html doc/source doc/_build/html

To improve API reference quality, write clear NumPy-style docstrings for public objects and keep module docstrings up to date.

For tool-authoring guidance, see Add a new tool.