DocuMind MCP Server

Un servidor MCP para analizar la calidad de la documentación mediante procesamiento neuronal avanzado.

Documentación

DocuMind MCP Server
EN doc JA doc

🌐 DocuMind MCP Server

"Donde la Documentación Encuentra la Inteligencia Digital"

Un servidor de Model Context Protocol (MCP) de próxima generación que revoluciona el análisis de calidad de documentación mediante procesamiento neuronal avanzado.

⚡ Sistemas Principales

  • 🧠 Análisis Neuronal de Documentación: Algoritmos avanzados para evaluación integral de README
  • 🔮 Escaneo Holográfico de Encabezados: Análisis SVG de vanguardia para elementos visuales
  • 🌍 Soporte Multidimensional de Idiomas: Verificación de documentación entre lenguajes
  • 💫 Motor Cuántico de Sugerencias: Recomendaciones de mejora impulsadas por IA

🚀 Secuencia de Arranque del Sistema

Requisitos del Sistema

  • Node.js 18+
  • npm || yarn

Inicializar Núcleo

npm install

Compilar Matriz

npm run build

Enlace de Desarrollo Neuronal

Establecer conexión neuronal en tiempo real:

npm run watch

🛸 Protocolo de Operación

Configuración del Sistema

Integrar con la mainframe de Claude Desktop:

Terminal de Windows:

// %APPDATA%/Claude/claude_desktop_config.json
{
  "mcpServers": {
    "documind-mcp-server": {
      "command": "/path/to/documind-mcp-server/build/index.js"
    }
  }
}

Comandos de Interfaz Neuronal

evaluate_readme

Inicia el análisis cuántico de la estructura de documentación.

Parámetros:

  • projectPath: Vía neuronal al directorio objetivo

Ejemplo de Solicitud:

{
  name: "evaluate_readme",
  arguments: {
    projectPath: "/path/to/project"
  }
}

Ejemplo de Respuesta:

{
  content: [
    {
      type: "text",
      text: JSON.stringify({
        filePath: "/path/to/project/README.md",
        hasHeaderImage: true,
        headerImageQuality: {
          hasGradient: true,
          hasAnimation: true,
          // ... other quality metrics
        },
        score: 95,
        suggestions: [
          "Consider adding language badges",
          // ... other suggestions
        ]
      })
    }
  ]
}

🔮 Matriz de Desarrollo

Protocolo de Depuración

Accede a la red neuronal a través de MCP Inspector:

npm run inspector

Guía de Solución de Problemas

Problemas Comunes y Soluciones

  1. Imagen de Encabezado No Detectada

    • Asegúrate de que el archivo SVG esté en el directorio assets/
    • Valida que el archivo SVG contenga estructura XML adecuada
    • Verifica los permisos de archivo
  2. Insignias de Idioma No Reconocidas

    • Verifica que las insignias usen el formato de shields.io
    • Comprueba que la estructura HTML siga el patrón recomendado
    • Asegura la alineación centrada adecuada
  3. Errores de Compilación

    • Limpia node_modules y reinstala las dependencias
    • Asegúrate de que la versión de TypeScript coincida con los requisitos del proyecto
    • Verifica errores de sintaxis en los archivos modificados
  4. Problemas de Conexión MCP

    • Verifica la configuración de transporte stdio
    • Comprueba la configuración de Claude Desktop
    • Asegura rutas de archivo correctas en la configuración

Optimización de Rendimiento

  1. Análisis SVG

    • Minimiza la complejidad del SVG para un análisis más rápido
    • Usa degradados y animaciones eficientes
    • Optimiza el tamaño del archivo manteniendo la calidad
  2. Escaneo de README

    • Estructura el contenido para un análisis óptimo
    • Usa patrones de markdown recomendados
    • Sigue las pautas de colocación de insignias

🔬 Documentación de API

Clases Principales

ReadmeService

Servicio principal para análisis y evaluación de README.

class ReadmeService {
  // Analyzes all README files in a project
  async evaluateAllReadmes(projectPath: string): Promise<ReadmeEvaluation[]>
  
  // Evaluates a single README file
  private async evaluateReadme(dirPath: string, readmePath: string): Promise<ReadmeEvaluation>
  
  // Evaluates language badge configuration
  private evaluateLanguageBadges(content: string): BadgeEvaluation
}

SVGService

Servicio especializado para análisis de imágenes de encabezado SVG.

class SVGService {
  // Evaluates SVG header image quality
  public evaluateHeaderImageQuality(imgSrc: string, content: string): HeaderImageQuality
  
  // Checks for project-specific elements in SVG
  private checkProjectSpecificImage(svgContent: string, readmeContent: string): boolean
}

Interfaces Principales

interface ReadmeEvaluation {
  filePath: string;
  hasHeaderImage: boolean;
  headerImageQuality: HeaderImageQuality;
  isCentered: {
    headerImage: boolean;
    title: boolean;
    badges: boolean;
  };
  hasBadges: {
    english: boolean;
    japanese: boolean;
    isCentered: boolean;
    hasCorrectFormat: boolean;
  };
  score: number;
  suggestions: string[];
}

interface HeaderImageQuality {
  hasGradient: boolean;
  hasAnimation: boolean;
  hasRoundedCorners: boolean;
  hasEnglishText: boolean;
  isProjectSpecific: boolean;
}

Manejo de Errores

El servidor implementa manejo integral de errores:

try {
  const evaluations = await readmeService.evaluateAllReadmes(projectPath);
  // Process results
} catch (error) {
  const errorMessage = error instanceof Error ? error.message : String(error);
  return {
    content: [{
      type: 'text',
      text: `Evaluation error: ${errorMessage}`
    }],
    isError: true
  };
}

⚡ Licencia

Operando bajo Protocolo MIT.