GitMCP: Descripción Detallada del Proyecto

🚀 Resumen del Proyecto

GitMCP es un servidor gratuito y de código abierto para el Protocolo de Contexto del Modelo (MCP) remoto, capaz de transformar cualquier proyecto de GitHub (repositorio o GitHub Pages) en un centro de documentación. Permite que herramientas de IA como Cursor accedan a la documentación y el código más recientes, incluso si el LLM nunca ha encontrado ese contenido, eliminando así sin problemas las alucinaciones de código.

Características Principales

• 😎 Documentación Actualizada de Cualquier Proyecto GitHub: Proporciona a los asistentes de IA acceso sin interrupciones a la documentación y el código de los proyectos de GitHub, con una función de búsqueda inteligente incorporada que ayuda a encontrar exactamente lo que la IA necesita.
• 🧠 Elimina las Alucinaciones: Con GitMCP, los asistentes de IA pueden proporcionar respuestas precisas y relevantes.
• ☁️ Cero Configuración: GitMCP se ejecuta en la nube; solo necesita añadir la URL de GitMCP como servidor MCP en su IDE.
• 💬 Chat Integrado: Converse directamente con la documentación del repositorio a través de un chat en el navegador.
• ✅ Abierto, Gratuito y Privado: Completamente de código abierto y de uso gratuito, no recopila información personal ni almacena consultas, y soporta el autoalojamiento.

🛠️ Cómo Funciona

GitMCP utiliza el estándar del Protocolo de Contexto del Modelo (MCP) para conectar asistentes de IA con repositorios de GitHub, un estándar que permite a las herramientas de IA solicitar información adicional de fuentes externas.

Flujo de Trabajo:

1. Proporcione la URL de GitMCP al asistente de IA (por ejemplo: gitmcp.io/microsoft/typescript).
2. GitMCP expone herramientas como la obtención de documentación, búsqueda inteligente, búsqueda de código, etc.
3. Haga una pregunta relacionada con la documentación/código al asistente de IA.
4. El asistente de IA envía una solicitud a GitMCP para usar sus herramientas (requiere su aprobación).
5. GitMCP ejecuta la solicitud de la IA y devuelve los datos necesarios.
6. El asistente de IA recibe la información y genera una respuesta más precisa y fundamentada, sin alucinaciones.

📋 Formatos de Documentación Soportados

GitMCP actualmente soporta la siguiente documentación en orden de prioridad:

1. llms.txt - Versión de la documentación del proyecto optimizada para IA.
2. README.md
3. Otros documentos en el directorio /root.

🔧 Cómo Configurar

Selección de Formato de URL

Elija uno de los siguientes formatos de URL según el contenido al que necesite conectarse:

• Repositorio GitHub: gitmcp.io/{owner}/{repo}
• Sitio web de GitHub Pages: {owner}.gitmcp.io/{repo}
• Herramienta Genérica (soporta cualquier repositorio, dinámico): gitmcp.io/docs

Ejemplos de Configuración de Herramientas de IA

Configuración de Cursor

Actualice el archivo ~/.cursor/mcp.json:

{
  "mcpServers": {
    "gitmcp": {
      "url": "https://gitmcp.io/{owner}/{repo}"
    }
  }
}

Configuración de Claude Desktop

En Configuración > Desarrollador > Editar Configuración, reemplace la configuración:

{
  "mcpServers": {
    "gitmcp": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://gitmcp.io/{owner}/{repo}"
      ]
    }
  }
}

Configuración de Windsurf

Actualice el archivo ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "gitmcp": {
      "serverUrl": "https://gitmcp.io/{owner}/{repo}"
    }
  }
}

🔨 Herramientas Disponibles

1. Obtener Documentación (fetch_documentation)

Obtiene la documentación principal de un repositorio de GitHub, proporcionando una visión general del proyecto a la IA mediante la recuperación de documentos relevantes (como llms.txt).

Escenarios de uso: Preguntas generales sobre el propósito, las características o las guías de inicio del proyecto.

2. Buscar Documentación (search_documentation)

Permite a la IA buscar en la documentación del repositorio mediante una consulta de búsqueda específica, utilizando una búsqueda inteligente para encontrar secciones relevantes en lugar de cargar toda la documentación.

Escenarios de uso: Preguntas específicas sobre una característica, función o concepto dentro del proyecto.

3. Obtener Contenido de Enlace (fetch_link_content)

Ayuda a la IA a obtener información de enlaces mencionados en la documentación, recuperando el contenido de esos enlaces y convirtiéndolo a un formato legible por la IA.

Escenarios de uso: Cuando la documentación hace referencia a información externa que podría ayudar a responder una pregunta.

4. Buscar Código (search_code)

Utiliza la función de búsqueda de código de GitHub para buscar en el código real del repositorio, ayudando a la IA a encontrar ejemplos de código específicos o detalles de implementación.

Escenarios de uso: Cuando se necesitan ejemplos de implementación o detalles técnicos no cubiertos por la documentación.

📊 Integración de Insignias

GitMCP ofrece insignias de repositorio que permiten a los usuarios acceder rápidamente a la documentación a través de su IDE o navegador, y muestran el número de veces que se ha accedido a la documentación a través de GitMCP.

Añadir Insignia

Añada el siguiente código en su README.md:

[![GitMCP](https://img.shields.io/endpoint?url=https://gitmcp.io/badge/OWNER/REPO)](https://gitmcp.io/OWNER/REPO)

Parámetros Personalizables de la Insignia

Parámetro	Descripción	Valor por Defecto	Ejemplo
color	Color del valor de la insignia	aquamarine	?color=green
label	Etiqueta de la insignia	GitMCP	Documentation

🛡️ Privacidad y Seguridad

• Compromiso con la Privacidad: GitMCP se preocupa profundamente por la privacidad del usuario, no requiere autenticación y no puede acceder ni almacenar ninguna información de identificación personal.
• Consultas No Almacenadas: No se almacena ninguna consulta enviada por el proxy.
• Transparencia de Código Abierto: Como proyecto de código abierto, puede implementarse de forma independiente en su propio entorno.
• Acceso Bajo Demanda: Solo accede a contenido que ya está disponible públicamente y solo cuando el usuario lo consulta.
• Cumplimiento de Reglas: Antes de acceder a los sitios web de GitHub Pages, verifica las reglas de robots.txt y sigue las instrucciones establecidas por el propietario del sitio web.

🚦 Restricciones de Uso

GitMCP solo accede al contenido cuando se le consulta; no rastrea automáticamente los repositorios. Para los sitios web de GitHub Pages, verifica y sigue las reglas de robots.txt, permitiendo a los propietarios del sitio web optar por no participar. GitMCP no almacena permanentemente datos sobre los proyectos de GitHub o su contenido.

💻 Desarrollo y Contribución

Ejecución Local

# Clonar el repositorio
git clone https://github.com/idosal/git-mcp.git
cd git-mcp

# Instalar dependencias
pnpm install

# Ejecutar para desarrollo local
npm run dev # o pnpm dev

Herramienta de Inspección MCP

# Instalar la herramienta de inspección MCP
npx @modelcontextprotocol/inspector

En la interfaz del inspector:

• Establezca el tipo de transporte en SSE.
• Introduzca la URL de GitMCP (por ejemplo: http://localhost:5173/docs).
• Haga clic en "Conectar".

📄 Licencia

Este proyecto está licenciado bajo la Licencia Apache 2.0.

⚠️ Descargo de Responsabilidad

GitMCP se proporciona "tal cual", sin garantías de ningún tipo. Aunque nos esforzamos por garantizar la fiabilidad y seguridad del servicio, no nos hacemos responsables de ningún daño o problema que pueda surgir de su uso. Los proyectos de GitHub a los que se accede a través de GitMCP están sujetos a los términos y condiciones de sus respectivos propietarios. GitMCP no está afiliado a GitHub ni a ninguna de las herramientas de IA mencionadas.