hybrid server
The server is able to function both locally and remotely, depending on the configuration or use case.
Integrations
The MCP server integrates with Codecov for tracking code coverage metrics, as evidenced by the Codecov badge in the README.
The MCP server integrates with GitHub for version control, repository hosting, and showing build status through badges.
The MCP server uses GitHub Actions for continuous integration and deployment, running tests across Python versions, checking code formatting, performing type checking, security scans, and generating coverage reports.
Servidor MCP Neurolorap
Servidor MCP que proporciona herramientas para el análisis y documentación de código.
Características
Herramienta de recopilación de código
- Recopilar código de todo el proyecto
- Recopilar código de directorios o archivos específicos
- Recopilar código de múltiples rutas
- Salida Markdown con resaltado de sintaxis
- Generación de índices
- Soporte para múltiples lenguajes de programación
Herramienta de generación de informes de estructura de proyecto
- Analizar la estructura y las métricas del proyecto
- Generar informes detallados en formato Markdown
- Análisis del tamaño y complejidad de los archivos
- Visualización basada en árboles
- Recomendaciones para la organización del código
- Patrones de ignorancia personalizables
Descripción rápida
No necesitas instalar ni configurar ninguna dependencia manualmente. La herramienta configurará todo lo necesario para analizar y documentar el código.
Instalación
Necesitará tener UV >= 0.4.10 instalado en su máquina.
Para instalar y ejecutar el servidor:
Esto automáticamente:
- Instalar todas las dependencias necesarias
- Configurar la integración de Cline
- Configurar el servidor para uso inmediato
El servidor estará disponible mediante el protocolo MCP en Cline. Podrás usarlo para analizar y documentar el código de cualquier proyecto.
Uso
Modo de desarrollador
El servidor incluye un modo de desarrollador con interfaz de terminal JSON-RPC para interacción directa:
Comandos disponibles:
help
: Mostrar comandos disponibleslist_tools
: Lista de las herramientas MCP disponiblescollect <path>
: Recopilar código de la ruta especificadareport [path]
: Generar informe de estructura del proyectoexit
: Salir del modo desarrollador
Sesión de ejemplo:
A través de herramientas MCP
Colección de códigos
Análisis de la estructura del proyecto
Almacenamiento de archivos
El servidor utiliza un enfoque estructurado para el almacenamiento de archivos:
- Todos los archivos generados se almacenan en
~/.mcp-docs/<project-name>/
- Se crea un enlace simbólico
.neurolora
en la raíz de su proyecto que apunta a este directorio
Esto garantiza:
- Estructura de proyecto limpia
- Organización de archivos consistente
- Fácil acceso a los archivos generados
- Soporte para múltiples proyectos
- Sincronización confiable de archivos en diferentes entornos de SO
- Visibilidad rápida de archivos en IDE y exploradores de archivos
Personalización de patrones de ignoración
Cree un archivo .neuroloraignore
en la raíz de su proyecto para personalizar qué archivos se ignoran:
Si no existe ningún archivo .neuroloraignore
, se creará uno predeterminado con patrones de ignorado comunes.
Desarrollo
- Clonar el repositorio
- Crear y activar entorno virtual:
- Instalar dependencias de desarrollo:
- Ejecutar el servidor:
Pruebas
El proyecto mantiene altos estándares de calidad a través de pruebas automatizadas e integración continua:
- Conjunto de pruebas completo con más del 80 % de cobertura de código
- Pruebas automatizadas en Python 3.10, 3.11 y 3.12
- Integración continua a través de GitHub Actions
- Análisis de seguridad periódicos y comprobaciones de dependencia
Para conocer detalles sobre el desarrollo y las pruebas, consulte PROJECT_SUMMARY.md.
Calidad del código
El proyecto mantiene altos estándares de calidad de código a través de varias herramientas:
Todas estas comprobaciones se ejecutan automáticamente en las solicitudes de extracción a través de GitHub Actions.
Canalización de CI/CD
El proyecto utiliza GitHub Actions para la integración y la implementación continuas:
- Ejecuta pruebas en Python 3.10, 3.11 y 3.12
- Comprueba el formato y el estilo del código
- Realiza la verificación de tipos
- Ejecuta análisis de seguridad
- Genera informes de cobertura
- Construye y valida el paquete
- Sube artefactos de prueba
La tubería debe pasar antes de fusionar cualquier cambio.
Contribuyendo
¡Agradecemos sus contribuciones! Consulte las directrices en CONTRIBUTING.md .
Licencia
Licencia MIT. Consulte el archivo de LICENCIA para obtener más detalles.
You must be authenticated.
Servidor MCP para recopilar código de archivos y directorios en un único documento Markdown.