article
README
🚀 FastAPI-MCP 中文版
FastAPI-MCP 能够将您的 FastAPI 端点作为 Model Context Protocol (MCP) 工具暴露,并且附带身份验证功能,为您的项目提供便捷且安全的服务。
🚀 快速开始
如果您希望快速开始,请访问 官方文档。
✨ 主要特性
- 内置身份验证:可使用您现有的 FastAPI 依赖!
- FastAPI 原生:并非另一个 OpenAPI -> MCP 转换器。
- 零/最小配置:只需指向您的 FastAPI 应用即可运行。
- 保留模式的请求和响应模型:保留 schema。
- 保留文档:所有端点的文档与 Swagger 中完全一致。
- 灵活部署:可将您的 MCP 服务器挂载到同一应用,或单独部署。
- ASGI 传输:直接使用 FastAPI 的 ASGI 接口进行高效通信。
📦 安装指南
我们推荐使用 uv 进行快速安装:
uv add fastapi-mcp
或者,使用 pip 安装:
pip install fastapi-mcp
💻 使用示例
基础用法
from fastapi import FastAPI
from fastapi_mcp import FastAPI_MCP
app = FastAPI()
mcp = FastAPI_MCP(app)
📚 详细文档
欢迎贡献!请参考项目仓库中的 CONTRIBUTING.md 文件。
🔧 技术细节
- 需求:
- Python 3.10+(推荐 3.12)
- uv
📄 许可证
MIT License. Copyright (c) 2024 Tadata Inc.
微信扫一扫