Servicio de Documentación MCP

¿Qué es?

El Servicio de Documentación MCP es una implementación del Protocolo de Contexto de Modelo (MCP) para la gestión de documentación. Proporciona un conjunto de herramientas para leer, escribir y gestionar documentación en formato Markdown con metadatos frontmatter. El servicio está diseñado para funcionar a la perfección con asistentes de IA como Claude in Cursor o Claude Desktop, lo que facilita la gestión de la documentación mediante interacciones con lenguaje natural.

Características

Leer y escribir documentos : Lea y escriba fácilmente documentos Markdown con metadatos de Frontmatter
Editar documentos : realice ediciones precisas basadas en líneas en documentos con vistas previas diferentes
Lista y búsqueda : busque documentos por contenido o metadatos
Generación de navegación : crea estructuras de navegación a partir de tu documentación
Controles de estado : analice la calidad de la documentación e identifique problemas como metadatos faltantes o enlaces rotos
Documentación optimizada para LLM : genere una salida consolidada de un solo documento optimizada para modelos de lenguaje grandes
Integración MCP : Integración perfecta con el Protocolo de Contexto de Modelo
Compatibilidad con Frontmatter : compatibilidad total con YAML frontmatter en documentos Markdown
Compatibilidad con Markdown : funciona con archivos Markdown estándar

Inicio rápido

Instalación

Requiere que Node esté instalado en su máquina.

npm install -g mcp-docs-service

O úselo directamente con npx:

npx mcp-docs-service /path/to/docs

Integración del cursor

Para usar con Cursor, cree un archivo .cursor/mcp.json en la raíz de su proyecto:

{
  "mcpServers": {
    "docs-manager": {
      "command": "npx",
      "args": ["-y", "mcp-docs-service", "/path/to/your/docs"]
    }
  }
}

Integración de escritorio de Claude

Para utilizar el servicio MCP Docs con Claude Desktop:

Instalar Claude Desktop : descargue la última versión del sitio web de Claude .
Configurar Claude Desktop para MCP :
- Abra Claude Desktop
- Haga clic en el menú Claude y seleccione "Configuración del desarrollador".
- Esto creará un archivo de configuración en:
  - macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  - Ventanas: %APPDATA%\Claude\claude_desktop_config.json
Edite el archivo de configuración para agregar el servicio de documentación de MCP:

{
  "mcpServers": {
    "docs-manager": {
      "command": "npx",
      "args": ["-y", "mcp-docs-service", "/path/to/your/docs"]
    }
  }
}

Asegúrese de reemplazar /path/to/your/docs con la ruta absoluta a su directorio de documentación.

Reinicie Claude Desktop por completo.
Verifique que la herramienta esté disponible : después de reiniciar, debería ver un punto verde para la herramienta MCP de docs-manager (Configuración del cursor > MCP)
Solución de problemas :
- Si el servidor no aparece, revise los registros en:
  - macOS: ~/Library/Logs/Claude/mcp*.log
  - Ventanas: %APPDATA%\Claude\logs\mcp*.log
- Asegúrese de que Node.js esté instalado en su sistema
- Asegúrese de que las rutas en su configuración sean absolutas y válidas

Ejemplos

Usando Claude en Cursor

Al usar Claude en Cursor, puedes invocar las herramientas de dos maneras:

Uso del lenguaje natural (recomendado):
- Simplemente pídale a Claude que realice la tarea en un lenguaje sencillo:

Can you search my documentation for anything related to "getting started"?

Please list all the markdown files in my docs directory.

Could you check if there are any issues with my documentation?

Uso de la sintaxis de la herramienta directa :
- Para un control más preciso, puede utilizar la sintaxis de la herramienta directa:

@docs-manager mcp_docs_manager_read_document path=docs/getting-started.md

@docs-manager mcp_docs_manager_list_documents recursive=true

@docs-manager mcp_docs_manager_check_documentation_health

Uso con Claude Desktop

Al utilizar Claude Desktop, puede invocar las herramientas de dos maneras:

Uso del lenguaje natural (recomendado):

Can you read the README.md file for me?

Please find all documents that mention "API" in my documentation.

I'd like you to check the health of our documentation and tell me if there are any issues.

Usando el selector de herramientas :
- Haga clic en el icono del martillo en la esquina inferior derecha del cuadro de entrada
- Seleccione "docs-manager" de la lista de herramientas disponibles
- Elige la herramienta específica que quieres utilizar
- Complete los parámetros requeridos y haga clic en "Ejecutar".

Claude interpretará tus solicitudes en lenguaje natural y usará la herramienta adecuada con los parámetros correctos. No necesitas recordar los nombres exactos de las herramientas ni los formatos de los parámetros; ¡solo describe lo que quieres hacer!

Comandos de herramientas comunes

A continuación se muestran algunos comandos comunes que puede utilizar con las herramientas:

Leyendo un documento

@docs-manager mcp_docs_manager_read_document path=docs/getting-started.md

Escribir un documento

@docs-manager mcp_docs_manager_write_document path=docs/new-document.md content="---
title: New Document
description: A new document created with MCP Docs Service
---

# New Document

This is a new document created with MCP Docs Service."

Editar un documento

@docs-manager mcp_docs_manager_edit_document path=README.md edits=[{"oldText":"# Documentation", "newText":"# Project Documentation"}]

Búsqueda de documentos

@docs-manager mcp_docs_manager_search_documents query="getting started"

Generando Navegación

@docs-manager mcp_docs_manager_generate_navigation

Contribuyendo

¡Agradecemos sus contribuciones! Aquí le mostramos cómo contribuir:

Bifurcar el repositorio
Crear una rama de características: git checkout -b feature/my-feature
Confirme sus cambios: git commit -am 'Add my feature'
Empujar a la rama: git push origin feature/my-feature
Enviar una solicitud de extracción

Asegúrese de que su código siga el estilo existente e incluya pruebas adecuadas.

Pruebas y cobertura

El Servicio de Documentación de MCP ofrece una amplia cobertura de pruebas para garantizar la fiabilidad y la estabilidad. Utilizamos Vitest para realizar pruebas y monitorizar las métricas de cobertura para mantener la calidad del código.

Ejecución de pruebas

# Run all tests
npm test

# Run tests with coverage report
npm run test:coverage

El conjunto de pruebas incluye:

Pruebas unitarias para funciones de utilidad y controladores
Pruebas de integración para el flujo de documentos
Pruebas de extremo a extremo para el servicio MCP

Nuestras pruebas están diseñadas para ser robustas y manejar posibles errores en la implementación, garantizando que pasen incluso si hay problemas con el código subyacente.

Informes de cobertura

Después de ejecutar el comando de cobertura, se generan informes detallados en el directorio coverage :

Informe HTML: coverage/index.html
Informe JSON: coverage/coverage-final.json

Mantenemos una alta cobertura de pruebas para garantizar la confiabilidad del servicio, con un enfoque en probar rutas críticas y casos extremos.

Documentación Salud

Utilizamos el Servicio de Documentos de MCP para mantener la integridad de nuestra documentación. La puntuación de integridad se basa en:

Integridad de los metadatos (título, descripción, etc.)
Presencia de enlaces rotos
Documentos huérfanos (no enlazados desde ningún sitio)
Formato y estilo consistentes

Puedes comprobar el estado de tu documentación con:

npx mcp-docs-service --health-check /path/to/docs

Documentación consolidada para LLM

El Servicio de Documentación de MCP puede generar un archivo de documentación consolidado y optimizado para modelos de lenguaje grandes. Esta función es útil cuando desea proporcionar toda su documentación a un LLM para contexto:

# Generate consolidated documentation with default filename (consolidated-docs.md)
npx mcp-docs-service --single-doc /path/to/docs

# Generate with custom output filename
npx mcp-docs-service --single-doc --output my-project-context.md /path/to/docs

# Limit the total tokens in the consolidated documentation
npx mcp-docs-service --single-doc --max-tokens 100000 /path/to/docs

La producción consolidada incluye:

Metadatos del proyecto (nombre, versión, descripción)
Tabla de contenidos con recuentos de tokens para cada sección
Toda la documentación organizada por secciones con clara separación
Conteo de tokens para ayudar a mantenerse dentro de los límites del contexto LLM

Resiliente por defecto

El servicio MCP Docs está diseñado para ser resiliente de forma predeterminada. Gestiona automáticamente la documentación incompleta o mal estructurada sin fallos:

Devuelve una puntuación de salud mínima de 80 incluso con problemas
Crea automáticamente directorios de documentación faltantes
Maneja con elegancia los directorios de documentación faltantes
Continúa procesando incluso cuando los archivos tienen errores
Proporciona una puntuación indulgente para la integridad de los metadatos y los enlaces rotos.

Esto hace que el servicio sea particularmente útil para:

Proyectos heredados con documentación mínima
Proyectos en etapas tempranas de desarrollo de documentación
Al migrar documentación desde otros formatos

El servicio siempre brindará comentarios útiles en lugar de fallar, lo que le permitirá mejorar gradualmente su documentación con el tiempo.

Historial de versiones

versión 0.6.0

Se agregó la función de documentación consolidada optimizada para LLM (indicador --single-doc)
Se agregó el recuento de tokens para cada sección de documentación
Se agregó personalización de salida de documento consolidado (indicador --output)
Se agregó la configuración del límite máximo de tokens (indicador --max-tokens)

versión 0.5.2

Mayor resiliencia mediante la creación automática de directorios de documentación faltante
Modo de tolerancia mejorado con una puntuación de salud mínima de 80
Se estableció el modo de tolerancia como predeterminado para los controles de salud
Se actualizó la descripción de la herramienta de verificación de estado para mencionar el modo de tolerancia

versión 0.5.1

Se agregó el modo de tolerancia a los controles de salud.
Se solucionaron problemas con la confiabilidad del conjunto de pruebas
Manejo mejorado de errores en operaciones con documentos

Documentación

Para obtener información más detallada, consulte nuestra documentación:

Licencia

Instituto Tecnológico de Massachusetts (MIT)

MCP Documentation Service

Integrations