π The fast, Pythonic way to build MCP servers and clients.
Add docs
Jeremiah Lowin7266daa753cd
diff --git a/docs/docs.json b/docs/docs.jsonindex 237dee35b..c70f80404 100644--- a/docs/docs.json+++ b/docs/docs.json@@ -61,7 +61,8 @@"patterns/composition","patterns/decorating-methods","patterns/openapi",- "patterns/fastapi"+ "patterns/fastapi",+ "patterns/contrib"]},{diff --git a/docs/patterns/contrib.mdx b/docs/patterns/contrib.mdxnew file mode 100644index 000000000..4ae3b3d11--- /dev/null+++ b/docs/patterns/contrib.mdx@@ -0,0 +1,40 @@+---+title: "Contrib Modules"+description: "Community-contributed modules extending FastMCP"+icon: "cubes"+---+++FastMCP includes a `contrib` package that holds community-contributed modules. These modules extend FastMCP's functionality but aren't officially maintained by the core team.++Contrib modules provide additional features, integrations, or patterns that complement the core FastMCP library. They offer a way for the community to share useful extensions while keeping the core library focused and maintainable.++## Usage++To use a contrib module, import it from the `fastmcp.contrib` package:++```python+from fastmcp.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 FastMCP 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 FastMCP in a useful way, consider contributing it:++1. Create a new directory in `src/fastmcp/contrib/` for your module+3. Add proper tests for your module in `tests/contrib/`+2. Include comprehensive documentation in a README.md file, including usage and examples, as well as any additional dependencies or installation instructions+5. Submit a pull request++The ideal contrib module:+- Solves a specific use case or integration need+- Follows FastMCP coding standards+- Includes thorough documentation and examples+- Has comprehensive tests+- Specifies any additional dependencies