hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
Integrations
Características
- Integración directa : monte un servidor MCP directamente en su aplicación FastAPI
- No requiere configuración : simplemente apúntelo a su aplicación FastAPI y funcionará
- Detección automática de todos los puntos finales de FastAPI y conversión a herramientas MCP
- Preservación de esquemas de sus modelos de solicitud y modelos de respuesta
- Conserve la documentación de todos sus puntos finales, tal como está en Swagger
- Implementación flexible : monte su servidor MCP en la misma aplicación o impleméntelo por separado
Instalación
Recomendamos utilizar uv , un instalador rápido de paquetes de Python:
Alternativamente, puedes instalarlo con pip:
Uso básico
La forma más sencilla de utilizar FastAPI-MCP es agregar un servidor MCP directamente a su aplicación FastAPI:
¡Listo! Tu servidor MCP generado automáticamente ya está disponible en https://app.base.url/mcp
.
Nota sobre
base_url
: Aunquebase_url
es opcional, se recomienda proporcionarla explícitamente. Estabase_url
indica al servidor MCP dónde enviar las solicitudes de API cuando se invocan las herramientas. Sin ella, la biblioteca intentará determinar la URL automáticamente, lo que podría no funcionar correctamente en entornos implementados donde las URL internas y externas difieren.
Nombre de la herramienta
FastAPI-MCP usa el operation_id
de sus rutas FastAPI como nombre de las herramientas MCP. Si no especifica un operation_id
, FastAPI genera uno automáticamente, pero estos pueden ser crípticos.
Compare estas dos definiciones de puntos finales:
Para obtener nombres de herramientas más claros e intuitivos, recomendamos agregar parámetros operation_id
explícitos a las definiciones de ruta FastAPI.
Para obtener más información, lea la documentación oficial de FastAPI sobre la configuración avanzada de operaciones de ruta.
Uso avanzado
FastAPI-MCP ofrece varias maneras de personalizar y controlar la creación y configuración de su servidor MCP. A continuación, se muestran algunos patrones de uso avanzados:
Personalización de la descripción del esquema
Personalización de puntos finales expuestos
Puede controlar qué puntos finales de FastAPI se exponen como herramientas MCP mediante identificadores o etiquetas de operaciones de Open API:
Notas sobre el filtrado:
- No puedes usar
include_operations
yexclude_operations
al mismo tiempo - No puedes usar
include_tags
yexclude_tags
al mismo tiempo - Puede combinar el filtrado de operaciones con el filtrado de etiquetas (por ejemplo, utilice
include_operations
coninclude_tags
) - Al combinar filtros, se adoptará un enfoque ambicioso. Se incluirán los puntos finales que cumplan cualquiera de los criterios.
Implementación por separado de la aplicación FastAPI original
No está limitado a servir el MCP en la misma aplicación FastAPI desde la que se creó.
Puede crear un servidor MCP desde una aplicación FastAPI y montarlo en una aplicación diferente:
Agregar puntos finales después de la creación del servidor MCP
Si agrega puntos finales a su aplicación FastAPI después de crear el servidor MCP, deberá actualizar el servidor para incluirlos:
Ejemplos
Consulte el directorio de ejemplos para ver ejemplos completos.
Conexión al servidor MCP mediante SSE
Una vez que su aplicación FastAPI con integración MCP esté en ejecución, puede conectarse a ella con cualquier cliente MCP compatible con SSE, como Cursor:
- Ejecute su aplicación.
- En Cursor -> Configuración -> MCP, use la URL del punto final de su servidor MCP (por ejemplo,
http://localhost:8000/mcp
) como sse. - El cursor descubrirá automáticamente todas las herramientas y recursos disponibles.
Conexión al servidor MCP mediante mcp-proxy stdio
Si su cliente MCP no admite SSE, por ejemplo Claude Desktop:
- Ejecute su aplicación.
- Instale mcp-proxy , por ejemplo:
uv tool install mcp-proxy
. - Agregue el archivo de configuración MCP de Claude Desktop (
claude_desktop_config.json
):
En Windows:
En MacOS:
Encuentre la ruta a mcp-proxy ejecutando en la Terminal: which mcp-proxy
.
- Claude Desktop descubrirá automáticamente todas las herramientas y recursos disponibles
Desarrollo y contribución
Gracias por considerar contribuir a FastAPI-MCP. Animamos a la comunidad a publicar incidencias y solicitudes de incorporación de cambios.
Antes de comenzar, consulte nuestra Guía de contribuciones .
Comunidad
Únase a la comunidad Slack de MCParty para conectarse con otros entusiastas de MCP, hacer preguntas y compartir sus experiencias con FastAPI-MCP.
Requisitos
- Python 3.10+ (recomendado 3.12)
- ultravioleta
Licencia
Licencia MIT. Copyright (c) 2024 Tadata Inc.
This server cannot be installed
Una herramienta de configuración cero que expone automáticamente los puntos finales de FastAPI como herramientas de Protocolo de contexto de modelo (MCP), lo que permite que los sistemas LLM como Claude interactúen con su API sin codificación adicional.
- Installation
- Basic Usage
- Tool Naming
- Advanced Usage
- Examples
- Connecting to the MCP Server using SSE
- Connecting to the MCP Server using mcp-proxy stdio
- Development and Contributing
- Community
- Requirements
- License