The MADA Tools Developer Guide

Welcome to the Developer Guide for the MADA Tools project! This comprehensive guide is designed to provide developers with a detailed understanding of the various modules, classes, and functions available within this project's API. It will also provide:

• A guide to the architecture of the codebase.
• A Testing Guide
• An explanation on how documentation is deployed
• The Release Workflow
• Instructions for Creating MCP Servers, including:
  • Adding Servers Directly to the MADA Tools Repository
  • Creating Plugin MCP Servers

Installation for Developers

Follow the Basic Installation instructions, but for the final step install all dependencies:

pip install -e .[all]

Once installed, set up pre-commit:

pre-commit install

Now the pre-commit hooks will run before each commit. You can automatically fix most linting and formatting issues by running the following commands from the top of the repository:

ruff check --fix
ruff format

We appreciate your contributions!