Create a Tutorial for Constructing Plugin Projects
Open
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:
- Creating a plugin project with an MCP server (can refer to basic tutorial from #33)
- Adding an
extensions.pyfile that utilizes theExtensionManifestandMCPServerRegistrationclasses - Adding a
pyproject.tomlfile that sets theextensions.pyfile as an entry point for the package - Creating a venv and
pip install -e .on the project - Running
mada-tools available-serversto see that the server we created is now available to use - [Optional] Showing how documentation can be extended with
mada-tools export-docs(refer to the CZ repo for best way to document this) - [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
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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