New in version: 2.2.1
FlashMCP includes a contrib package that holds community-contributed modules. These modules extend FlashMCP’s functionality but aren’t officially maintained by the core team. Contrib modules provide additional features, integrations, or patterns that complement the core FlashMCP library. They offer a way for the community to share useful extensions while keeping the core library focused and maintainable. The available modules can be viewed in the contrib directory.

Usage

To use a contrib module, import it from the FlashMCP.contrib package:
from FlashMCP.contrib import my_module

Important Considerations

  • Stability: Modules in contrib may have different testing requirements or stability guarantees compared to the core library.
  • Compatibility: Changes to core FlashMCP might break modules in contrib without explicit warnings in the main changelog.
  • Dependencies: Contrib modules may have additional dependencies not required by the core library. These dependencies are typically documented in the module’s README or separate requirements files.

Contributing

We welcome contributions to the contrib package! If you have a module that extends FlashMCP in a useful way, consider contributing it:
  1. Create a new directory in src/FlashMCP/contrib/ for your module
  2. Add proper tests for your module in tests/contrib/
  3. Include comprehensive documentation in a README.md file, including usage and examples, as well as any additional dependencies or installation instructions
  4. Submit a pull request
The ideal contrib module:
  • Solves a specific use case or integration need
  • Follows FlashMCP coding standards
  • Includes thorough documentation and examples
  • Has comprehensive tests
  • Specifies any additional dependencies