New in version: 2.2.1

FastMCP包含一个contrib包,其中存放着社区贡献的模块。这些模块扩展了FastMCP的功能,但不由核心团队官方维护。

Contrib模块提供了额外的功能、集成或模式,这些内容是对核心FastMCP库的补充。它们为社区提供了一种分享有用扩展的方式,同时保持核心库的专注性和可维护性。

可用模块可以在contrib目录中查看。

使用说明

要使用一个贡献模块,请从fastmcp.contrib包中导入:

from fastmcp.contrib import my_module

重要注意事项

  • 稳定性: 与核心库相比,contrib中的模块可能有不同的测试要求或稳定性保证。
  • 兼容性: 对核心FastMCP的更改可能会破坏contrib中的模块,且主变更日志中不会给出明确警告。
  • 依赖项: 贡献模块可能包含核心库不需要的额外依赖项。这些依赖项通常记录在模块的README或单独的需求文件中。

贡献指南

我们欢迎对contrib包的贡献!如果您有一个以实用方式扩展FastMCP的模块,请考虑贡献它:

  1. src/fastmcp/contrib/目录下为您的模块创建一个新目录
  2. tests/contrib/目录下为您的模块添加适当的测试
  3. 在README.md文件中包含全面的文档,包括使用方法和示例,以及任何额外的依赖项或安装说明
  4. 提交一个拉取请求

理想的贡献模块:

  • 解决特定用例或集成需求
  • 遵循FastMCP编码标准
  • 包含全面的文档和示例
  • 拥有全面的测试
  • 指定任何额外的依赖项