llnl / llnl/mada-tools

Create a Tutorial for Constructing Plugin Projects

Open
#35 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
4
Forks
1
Avg merge
2d 5h
Merged PRs (30d)
3

Description

This should show:

  1. Creating a plugin project with an MCP server (can refer to basic tutorial from #33)
  2. Adding an extensions.py file that utilizes the ExtensionManifest and MCPServerRegistration classes
  3. Adding a pyproject.toml file that sets the extensions.py file as an entry point for the package
  4. Creating a venv and pip install -e . on the project
  5. Running mada-tools available-servers to see that the server we created is now available to use
  6. [Optional] Showing how documentation can be extended with mada-tools export-docs (refer to the CZ repo for best way to document this)
  7. [Optional] Showing how testing infrastructure is packaged and can be used with from mada_tools.testing import ... (refer to the CZ repo for the best way to document this)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the basic tutorial in issue #33, then review the referenced CZ repository for documentation and testing guidance. Create a tutorial covering extensions.py, pyproject.toml, virtualenv setup, editable installation, and mada-tools available-servers; optionally include export-docs and packaged testing usage. Done means a newcomer can follow the steps to create and discover the example plugin.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.