Grounded Docs: Tu experto en documentación actualizada para IA

Docs MCP Server resuelve el problema de las alucinaciones de la IA y el conocimiento desactualizado al proporcionar un índice de documentación personal y siempre actualizado para tu asistente de programación de IA. Obtiene documentación oficial de sitios web, GitHub, npm, PyPI y archivos locales, permitiendo que tu IA consulte la versión exacta que estás utilizando.

✨ ¿Por qué Grounded Docs MCP Server?

La alternativa de código abierto a Context7, Nia y Ref.Tools.

• ✅ Contexto actualizado: Obtiene documentación directamente de fuentes oficiales bajo demanda.

• 🎯 Específico por versión: Las consultas se dirigen a las versiones exactas de las bibliotecas en tu proyecto.

• 💡 Reduce las alucinaciones: Fundamenta los LLM en documentación real.

• 🔒 Privado y local: Se ejecuta completamente en tu máquina; tu código nunca sale de tu red.

• 🧩 Amplia compatibilidad: Funciona con cualquier cliente compatible con MCP (Claude, Cline, etc.).

• 📁 Múltiples fuentes: Indexa sitios web, repositorios de GitHub, carpetas locales y archivos zip.

• 📄 Soporte enriquecido de archivos: Procesa HTML, Markdown, PDF, documentos de Office (Word, Excel, PowerPoint), OpenDocument, RTF, EPUB, Jupyter Notebooks y más de 90 lenguajes de código fuente.

Related MCP server: Documentation Search MCP Server

📄 Formatos soportados

Consulta Formatos soportados para la referencia completa, incluyendo tipos MIME y detalles de procesamiento.

🚀 Inicio rápido

CLI primero

Para agentes y scripts, la CLI suele ser la forma más sencilla de usar Grounded Docs.

1. Indexar documentación (requiere Node.js 22+):

npx @arabold/docs-mcp-server@latest scrape react https://react.dev/reference/react

Para sitios de documentación SPA con rutas basadas en hash, habilita la preservación de hash explícitamente:

npx @arabold/docs-mcp-server@latest scrape my-spa https://docs.example.com/#/guide --preserve-hashes

2. Consultar el índice:

npx @arabold/docs-mcp-server@latest search react "useEffect cleanup" --output yaml

3. Obtener una sola página como Markdown:

npx @arabold/docs-mcp-server@latest fetch-url https://react.dev/reference/react/useEffect

Comportamiento de salida

• Los comandos estructurados devuelven JSON limpio en stdout por defecto en ejecuciones no interactivas.

• Usa --output json|yaml|toon para elegir un formato estructurado.

• Los comandos de texto plano como fetch-url mantienen su carga útil de texto en stdout.

• Los diagnósticos pasan por el registrador compartido y se mantienen fuera de stdout en ejecuciones no interactivas.

• Usa --quiet para suprimir diagnósticos que no sean errores o --verbose para habilitar la salida de depuración.

Habilidades de agente

El directorio skills/ contiene Habilidades de Agente que enseñan a los asistentes de programación de IA cómo usar la CLI, cubriendo la búsqueda de documentación, la gestión de índices y la obtención de URL.

Servidor MCP

Si deseas un endpoint MCP de larga duración para Claude, Cline, Copilot, Gemini CLI u otros clientes MCP:

1. Inicia el servidor:

npx @arabold/docs-mcp-server@latest

2. Abre la interfaz web en http://localhost:6280 para añadir documentación.

3. Conecta tu cliente de IA añadiendo esto a tu configuración de MCP (por ejemplo, claude_desktop_config.json):

{
  "mcpServers": {
    "docs-mcp-server": {
      "type": "sse",
      "url": "http://localhost:6280/sse"
    }
  }
}

Consulta Conexión de clientes para VS Code (Cline, Roo) y otras opciones de configuración.

scrape_docs también acepta preserveHashes: true para sitios de documentación que utilizan enrutamiento del lado del cliente basado en hash. Úsalo solo para SPA con rutas basadas en hash; los sitios normales suelen usar fragmentos de hash para anclas dentro de la página.

docker run --rm \
  -v docs-mcp-data:/data \
  -v docs-mcp-config:/config \
  -p 6280:6280 \
  ghcr.io/arabold/docs-mcp-server:latest \
  --protocol http --host 0.0.0.0 --port 6280

🧠 Configurar modelo de incrustación (Recomendado)

Usar un modelo de incrustación (embedding) es opcional, pero mejora drásticamente la calidad de la búsqueda al habilitar la búsqueda vectorial semántica.

Ejemplo: Habilitar incrustaciones de OpenAI

OPENAI_API_KEY="sk-proj-..." npx @arabold/docs-mcp-server@latest

Consulta Modelos de incrustación para configurar Ollama, Gemini, Azure y otros.

📚 Documentación

Primeros pasos

• Instalación: Guías de configuración detalladas para Docker, Node.js (npx) y modo embebido.

• Conexión de clientes: Cómo conectar Claude, VS Code (Cline/Roo) y otros clientes MCP.

• Uso básico: Uso de la interfaz web, CLI y rastreo de archivos locales.

• Configuración: Referencia completa para archivos de configuración y variables de entorno.

• Formatos soportados: Referencia completa de formatos de archivo y tipos MIME.

• Modelos de incrustación: Configura OpenAI, Ollama, Gemini y otros proveedores.

SPA con rutas basadas en hash

• Usa --preserve-hashes, preserveHashes de MCP o la casilla de verificación "Preserve Hash Routes" de la interfaz web solo para sitios de documentación que se enrutan con URL como #/guide.

• Cuando se habilita con scrapeMode=fetch, el rastreador actualiza automáticamente el trabajo a Playwright porque la obtención simple no puede evaluar las rutas de hash del lado del cliente.

• La actualización reutiliza la configuración preserveHashes almacenada por defecto, y los puntos de entrada de actualización de CLI/Web pueden anularla explícitamente.

Conceptos clave y arquitectura

• Modos de despliegue: Independiente vs. Distribuido (Docker Compose).

• Autenticación: Asegurando tu servidor con OAuth2/OIDC.

• Telemetría: Recopilación de datos de uso centrada en la privacidad.

• Arquitectura: Análisis profundo del diseño del sistema.

🤝 Contribución

¡Damos la bienvenida a las contribuciones! Por favor, consulta CONTRIBUTING.md para conocer las pautas de desarrollo e instrucciones de configuración.

Licencia

Este proyecto está bajo la Licencia MIT. Consulta LICENSE para más detalles.