wehub-resource-sync
60e0ffc959
Upgrade checks / Notify on failure (push) Has been cancelled
Upgrade checks / Close issue on success (push) Has been cancelled
Schema Crash Test / Real-world schema crash test (232K schemas) (push) Has been cancelled
Run static analysis / static_analysis (push) Has been cancelled
Tests / Tests: Python 3.10 on ubuntu-latest (push) Has been cancelled
Tests / Tests: Python 3.13 on ubuntu-latest (push) Has been cancelled
Tests / Tests: Python 3.10 on windows-latest (push) Has been cancelled
Tests / Tests with lowest-direct dependencies (push) Has been cancelled
Tests / MCP conformance tests (push) Has been cancelled
Tests / Integration tests (push) Has been cancelled
Tests / Package install smoke (push) Has been cancelled
Upgrade checks / Static analysis (push) Has been cancelled
Upgrade checks / Tests: Python 3.10 on ubuntu-latest (push) Has been cancelled
Upgrade checks / Tests: Python 3.13 on ubuntu-latest (push) Has been cancelled
Upgrade checks / Tests: Python 3.10 on windows-latest (push) Has been cancelled
Upgrade checks / Integration tests (push) Has been cancelled
Update MCPServerConfig Schema / update-config-schema (push) Has been cancelled
Update SDK Documentation / update-sdk-docs (push) Has been cancelled
46 lines
2.0 KiB
Plaintext
46 lines
2.0 KiB
Plaintext
---
|
|
title: "Contrib Modules"
|
|
description: "Community-contributed modules extending FastMCP"
|
|
icon: "cubes"
|
|
---
|
|
|
|
import { VersionBadge } from "/snippets/version-badge.mdx"
|
|
|
|
<VersionBadge version="2.2.1" />
|
|
|
|
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.
|
|
|
|
The available modules can be viewed in the [contrib directory](https://github.com/PrefectHQ/fastmcp/tree/main/fastmcp_slim/fastmcp/contrib).
|
|
|
|
## Usage
|
|
|
|
To use a contrib module, import it from the `fastmcp.contrib` package:
|
|
|
|
```python test="skip"
|
|
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 `fastmcp_slim/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
|