MCP Server Neurolorap

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

# Using uvx (recommended) uvx mcp-server-neurolorap # Or using pip (not recommended) pip install mcp-server-neurolorap

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:

# Install using uvx (recommended) uvx mcp-server-neurolorap # Or install using pip (not recommended) pip install mcp-server-neurolorap

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:

# Start the server in developer mode python -m mcp_server_neurolorap --dev

Comandos disponibles:

  • help : Mostrar comandos disponibles
  • list_tools : Lista de las herramientas MCP disponibles
  • collect <path> : Recopilar código de la ruta especificada
  • report [path] : Generar informe de estructura del proyecto
  • exit : Salir del modo desarrollador

Sesión de ejemplo:

> help Available commands: - help: Show this help message - list_tools: List available MCP tools - collect <path>: Collect code from specified path - report [path]: Generate project structure report - exit: Exit the terminal > list_tools ["code_collector", "project_structure_reporter"] > collect src Code collection complete! Output file: code_collection.md > report Project structure report generated: PROJECT_STRUCTURE_REPORT.md > exit Goodbye!

A través de herramientas MCP

Colección de códigos

from modelcontextprotocol import use_mcp_tool # Collect code from entire project result = use_mcp_tool( "code_collector", { "input": ".", "title": "My Project" } ) # Collect code from specific directory result = use_mcp_tool( "code_collector", { "input": "./src", "title": "Source Code" } ) # Collect code from multiple paths result = use_mcp_tool( "code_collector", { "input": ["./src", "./tests"], "title": "Project Files" } )

Análisis de la estructura del proyecto

# Generate project structure report result = use_mcp_tool( "project_structure_reporter", { "output_filename": "PROJECT_STRUCTURE_REPORT.md" } ) # Analyze specific directory with custom ignore patterns result = use_mcp_tool( "project_structure_reporter", { "output_filename": "src_structure.md", "ignore_patterns": ["*.pyc", "__pycache__"] } )

Almacenamiento de archivos

El servidor utiliza un enfoque estructurado para el almacenamiento de archivos:

  1. Todos los archivos generados se almacenan en ~/.mcp-docs/<project-name>/
  2. 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:

# Dependencies node_modules/ venv/ # Build dist/ build/ # Cache __pycache__/ *.pyc # IDE .vscode/ .idea/ # Generated files .neurolora/

Si no existe ningún archivo .neuroloraignore , se creará uno predeterminado con patrones de ignorado comunes.

Desarrollo

  1. Clonar el repositorio
  2. Crear y activar entorno virtual:
python -m venv .venv source .venv/bin/activate # On Unix # or .venv\Scripts\activate # On Windows
  1. Instalar dependencias de desarrollo:
pip install -e ".[dev]"
  1. Ejecutar el servidor:
# Normal mode (MCP server with stdio transport) python -m mcp_server_neurolorap # Developer mode (JSON-RPC terminal interface) python -m mcp_server_neurolorap --dev

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:

# Format code black . # Sort imports isort . # Lint code flake8 . # Type check mypy src tests # Security check bandit -r src/ safety check

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.

A
security – no known vulnerabilities
A
license - permissive license
A
quality - confirmed to work

Servidor MCP para recopilar código de archivos y directorios en un único documento Markdown.

  1. Features
    1. Code Collection Tool
    2. Project Structure Reporter Tool
  2. Quick Overview
    1. Installation
      1. Usage
        1. Developer Mode
        2. Through MCP Tools
        3. File Storage
        4. Customizing Ignore Patterns
      2. Development
        1. Testing
        2. Code Quality
        3. CI/CD Pipeline
      3. Contributing
        1. License
          ID: rg07wseeqe