OPTA API Documentation MCP Server
Un servidor MCP (Model Context Protocol) para consultar la documentación de la API de fútbol de OPTA.
Características
🔐 Autenticación automática con las credenciales de OPTA
🔍 Búsqueda inteligente en toda la documentación
📚 Cache de documentación para mejorar el rendimiento
🛠️ Herramientas MCP para consultar endpoints específicos
🔄 Actualización automática del cache cada 24 horas
🚀 Listo para despliegue en Render con configuración automática
📖 Documentación completa de endpoints con ejemplos
Instalación
Clona el repositorio:
Instala las dependencias:
Configura las variables de entorno:
Edita el archivo .env con tus credenciales de OPTA:
Uso
Desarrollo
Producción
Procesar Endpoints
Herramientas MCP Disponibles
get_endpoint_documentation
Obtiene la documentación HTML de un endpoint específico de OPTA y responde preguntas sobre ella.
Parámetros:
endpoint_code(string): Código del endpoint (ej: MA13, MA1, PE2, etc.)question(string): Pregunta sobre la documentación del endpoint
Ejemplo:
Configuración en Cursor
Para usar este servidor MCP en Cursor, agrega la siguiente configuración a tu ~/.cursor/mcp.json:
Despliegue en Render
El proyecto incluye configuración automática para despliegue en Render:
Conecta tu repositorio a Render
Render detectará automáticamente el
render.yamlConfigura las variables de entorno en Render:
OPTA_USERNAME: Tu usuario de OPTAOPTA_PASSWORD: Tu contraseña de OPTAOPTA_DOCS_BASE_URL: Ya configurado
Configuración de Render (render.yaml)
Estructura del Proyecto
Endpoints Conocidos
El servidor incluye los siguientes endpoints de OPTA:
MA13 - Soccer API Possession Events: Eventos de posesión en fútbol
MA3 - Soccer API Match Events: Eventos de partidos de fútbol
MA12 - Soccer API Match Expected Goals: Expected Goals de partidos
MA6 - Soccer API Commentary: Comentarios automáticos y manuales
MA1 - Soccer API Fixtures and Results: Fixtures y resultados
Ejemplos de Uso
Consultar Documentación de un Endpoint
Desarrollo
Agregar Nuevos Endpoints
Para agregar nuevos endpoints, edita el archivo src/services/optaScraper.ts y agrega las URLs en el array knownEndpoints.
Personalizar Búsqueda
Puedes modificar la lógica de búsqueda en src/services/documentationManager.ts para ajustar los pesos de relevancia.
Scripts Disponibles
npm run build: Compila el proyecto TypeScriptnpm run dev: Ejecuta en modo desarrollonpm start: Ejecuta en modo producciónnpm run process:endpoints: Procesa y actualiza los endpoints
Troubleshooting
Error de Autenticación
Verifica que las credenciales en
.envsean correctasAsegúrate de que tu cuenta tenga acceso a la documentación de OPTA
Error de Conexión
Verifica tu conexión a internet
Comprueba que la URL base sea accesible
Cache No Se Actualiza
Usa la herramienta
refresh_documentation_cachepara forzar una actualizaciónVerifica el estado del cache con
get_cache_status
Error de MCP Server
Verifica que el servidor esté corriendo:
npm startComprueba los logs del servidor
Asegúrate de que las dependencias estén actualizadas:
npm install
Tecnologías Utilizadas
Node.js: Runtime de JavaScript
TypeScript: Lenguaje de programación tipado
@modelcontextprotocol/sdk: SDK para servidores MCP
Axios: Cliente HTTP
Cheerio: Parser HTML
Zod: Validación de esquemas
Licencia
MIT