DevDocs: un servicio MCP para rastrear y organizar rápidamente la documentación técnica

Introducción general

DevDocs es una herramienta completamente gratuita y de código abierto desarrollada por el equipo de CyberAGI y alojada en GitHub. Diseñada para programadores y desarrolladores de software, parte de la URL de un documento técnico, rastrea automáticamente la página pertinente y la organiza en un archivo Markdown o JSON conciso. Incorpora MCP servidores, soporte para el uso del Claude El objetivo de DevDocs es reducir el tiempo de búsqueda de documentos de semanas a horas y ayudar a los desarrolladores a ponerse al día rápidamente con las nuevas tecnologías. Es adecuado para desarrolladores individuales, equipos y usuarios empresariales, y actualmente es gratuito, por lo que cualquiera puede descargarlo y utilizarlo.

Lista de funciones

• Rastreo inteligente de documentos: Introduce una URL y rastrea automáticamente las páginas relevantes, soportando de 1 a 5 niveles de profundidad.
• Organizar en múltiples formatosConvertir el contenido capturado en archivos Markdown o JSON para facilitar su lectura y posterior procesamiento.
• Integración del servidor MCP: Servidor MCP integrado que trabaja con grandes modelos como Claude para consultar documentos de forma inteligente.
• Detección automática de enlaces: Identifique y clasifique los subenlaces dentro de una página para garantizar la integridad del contenido.
• Aceleración del procesamiento paralelo: Rastrea varias páginas en varios hilos para aumentar la eficacia.
• rastreo selectivoEl usuario puede especificar qué extraer para evitar información irrelevante.
• Mecanismo de recuperación de erroresReintento automático cuando falla el rastreo para garantizar la estabilidad.
• Registro completoRegistra cada paso de la operación para facilitar la resolución de problemas.

Utilizar la ayuda

Proceso de instalación

DevDocs se ejecuta con Docker y es fácil de instalar. Aquí están los pasos detallados:

1. Preparar el entorno
   • Es necesario instalar Git y Docker:
     • Git: Descárgalo e instálalo desde git-scm.com.
     • Docker: Descarga Docker Desktop de docker.com e instálalo.
   • Para comprobar si Docker se está ejecutando correctamente, en el terminal, escriba docker --versionSi ves el número de versión, lo has conseguido.
2. Clonación de código
   • Abra un terminal (CMD o PowerShell para Windows, Terminal para Mac/Linux).
   • Introduzca el comando para descargar DevDocs:

     git clone https://github.com/cyberagiinc/DevDocs.git
     

   • Vaya al catálogo de proyectos:

     cd DevDocs
     

3. Inicio de los servicios
   • Ejecute el script de inicio según el sistema operativo:
     • Mac/Linux:

       ./docker-start.sh
       

     • Ventanas:

       docker-start.bat
       

   • Los usuarios de Windows pueden configurar manualmente los permisos de las carpetas si tienen problemas con los permisos:

     icacls logs /grant Everyone:F /T
     icacls storage /grant Everyone:F /T
     icacls crawl_results /grant Everyone:F /T
     

   • Tras el arranque, espere unos segundos y el terminal mostrará que el servicio se ha ejecutado correctamente.
4. herramienta de acceso
   • Abra su navegador y escriba http://localhost:3001para acceder a la interfaz de DevDocs.
   • Otras direcciones de servicio:
     • API de backend:http://localhost:24125
     • Crawl4AI Servicios:http://localhost:11235

Funciones principales

1. Rastrear la documentación técnica

• mover::
  1. Pegue la URL de destino en el cuadro de entrada de la interfaz, por ejemplo https://docs.example.com.
  2. Seleccione la profundidad de rastreo (1-5 capas, por defecto 5).
  3. Haga clic en "Iniciar rastreo".
  4. Espere a que se complete, la interfaz mostrará la lista de páginas rastreadas.
• tenga en cuenta::
  • El rastreo es rápido, procesando hasta 1.000 páginas por minuto.
  • Los resultados se guardan en el archivo <项目目录>/crawl_results Carpeta.
• Opciones avanzadas::
  • Dispone de rastreo selectivo, marcando lo que se necesita.

2. Organizar el contenido de los documentos

• plataforma::
  • Tras el rastreo, el contenido se organiza automáticamente en archivos Markdown o JSON.
  • existe <项目目录>/crawl_results que, por defecto, está en formato Markdown.
• Alternar formato::
  • Seleccione "Exportar a JSON" en los ajustes de la interfaz para ajustar el modelo a gran escala.

3. Uso de servidores MCP y grandes modelos

• intente::
  • Descargue e instale la aplicación Claude Desktop (anthropic.com).
  • El servidor MCP de DevDocs se ejecuta localmente por defecto y no requiere ninguna configuración adicional.
• mover::
  1. Abre la aplicación Claude.
  2. Introduzca una pregunta, por ejemplo "¿Qué dice este documento?
  3. Claude leerá los datos del servidor MCP y responderá.
• Uso ampliado::
  • Coloque el documento local en el <项目目录>/storageSe puede acceder directamente a Claude.
  • Apoyo a preguntas complejas como "cómo se aplica esta tecnología".

4. Registro y control

• Ver registro::
  • Los archivos de registro se encuentran en <项目目录>/logsincluido:
    • frontend.log: Front-end logs.
    • backend.logRegistros de back-end.
    • mcp.log: Registros del servidor MCP.
  • Ver registros en directo con Docker:

    docker logs -f devdocs-backend
    

• Interrupción de los servicios::
  • En el terminal, pulse Ctrl+CApaga todos los servicios.

5. Guiones prácticos

• El proyecto ofrece una variedad de guiones ubicados en el <项目目录>/scripts::
  • check_mcp_health.shCompruebe el estado del servidor MCP.
  • debug_crawl4ai.shDepuración del servicio de rastreo.
  • view_result.shVer resultados de rastreo.
• modo de funcionamiento::
  • Vaya al directorio del script en el terminal y escriba ./脚本名 Implantación.

Resumen del proceso operativo

1. Instala Docker y Git y descarga el código.
2. Ejecute el script de inicio para acceder a la interfaz.
3. Introduce la URL, rastrea y organiza el documento.
4. Consulta de contenidos con Claude para mayor eficacia.

escenario de aplicación

1. Rápido aprendizaje de nuevas tecnologías
   Introduce la URL de la documentación técnica y DevDocs rastreará y organizará todas las páginas. Puedes leerlas directamente, o utilizar Claude para hacer preguntas sobre usos específicos, y ponerte al día con la nueva tecnología en pocos días.
2. Trabajo en equipo
   Rastree documentos internos de la empresa y genere archivos Markdown. Los miembros del equipo realizan consultas a través del servidor MCP para compartir conocimientos rápidamente.
3. Desarrollo de aplicaciones de grandes modelos
   Recopile datos técnicos con DevDocs y genere archivos JSON. Acelere el desarrollo de aplicaciones de IA combinando servidores MCP y grandes modelos.
4. Desarrollo de proyectos individuales
   Los desarrolladores indie arrastran documentación con DevDocs, trabajan con VSCode y Claude, y crean prototipos de productos en días.

CONTROL DE CALIDAD

1. ¿Hay que pagar por DevDocs?
   Sin coste alguno. Es una herramienta de código abierto, de uso gratuito, y están previstas futuras funciones de la API.
2. ¿Se requiere experiencia en programación?
   No es necesario. La instalación se realiza con unas pocas líneas de comandos, seguidas de la interfaz.
3. ¿Y si falla el rastreo?
   Compruebe la red o vea el <项目目录>/logs Registro. El problema común es la insuficiencia de permisos, sólo tienes que seguir los pasos de instalación para ajustarlos.
4. ¿Apoyo a sitios privados?
   Soporte, siempre que el sitio web sea accesible. Los sitios web internos deben garantizar la conectividad a la red.
5. ¿Cuál es la diferencia con FireCrawl?
   DevDocs es gratuito, rastrea rápido (1000 páginas/minuto), admite 5 niveles de profundidad y servidores MCP, mientras que FireCrawl es de pago y tiene funciones limitadas.