github-repo-mcp

Repositorio de GitHub MCP

Tabla de contenido

✨ Características principales

• 💻 Compatible con Cursor, Windsurf, Claude Desktop y otros clientes MCP que admiten el protocolo stdio
• 🔎 Explorar el contenido de cualquier repositorio público de GitHub
• 📂 Navegar por los directorios y subdirectorios del repositorio
• 📝 Ver el contenido de los archivos de código y texto
• 📦 Fácil instalación a través del administrador de paquetes

Empezando

Prerrequisitos

Para instalar el servidor se requiere lo siguiente en su sistema:

• Node.js 18+
• npm o hilo

Paso 1. Instalación

Puedes instalar y ejecutar GitHub Repo MCP usando Smithery, NPX o configurando en mcp.json de tu IDE:

Sistema operativo Mac

Windows NPX

Windows NPX a través de .cursor/mcp.json

Windows NPX a través de .cursor/mcp.json (si la ruta no está configurada)

Instalación mediante herrería

Para instalar GitHub Repo MCP para Claude Desktop automáticamente a través de Smithery :

Espere unos segundos o haga clic en el botón de actualización varias veces si no se registra. Si sigue sin registrarse, asegúrese de haber ingresado el comando correcto.

Paso 2. Configuración

El servidor MCP de GitHub Repo puede usar un token de GitHub para establecer límites de velocidad más altos al acceder a la API de GitHub.

Variables de entorno

Configuración de un token de GitHub (opcional)

Aunque el servidor funciona sin autenticación, la API de GitHub tiene límites de velocidad mucho más bajos para solicitudes no autenticadas. Para aumentar tu límite de velocidad:

1. Crea un token de acceso personal en https://github.com/settings/tokens
2. Establezca el token como una variable de entorno en mcp.json:

Descripción general de las funciones

Herramientas de navegación del repositorio

El servidor proporciona tres herramientas principales para interactuar con los repositorios de GitHub:

1. getRepoAllDirectories

Enumera todos los archivos y directorios en la raíz de un repositorio de GitHub.

• Parámetros :
  • repoUrl : la URL del repositorio de GitHub (por ejemplo, " https://github.com/owner/repo ")

2. getRepoDirectories

Enumera el contenido de un directorio específico en un repositorio de GitHub.

• Parámetros :
  • repoUrl : La URL del repositorio de GitHub
  • path : la ruta del directorio a buscar (por ejemplo, "src")

3. getRepoFile

Recupera y muestra el contenido de un archivo específico de un repositorio de GitHub.

• Parámetros :
  • repoUrl : La URL del repositorio de GitHub
  • path : la ruta del archivo a buscar (por ejemplo, "src/index.js")

Ejemplos de uso

A continuación se muestran algunos ejemplos de cómo utilizar estas herramientas con un asistente de IA:

1. Explorar la raíz de un repositorio : pídale a su asistente de IA que "me muestre el contenido del repositorio en https://github.com/Ryan0204/github-repo-mcp "
2. Explorando un directorio específico : Pregunte "¿Qué archivos hay en el directorio src de https://github.com/Ryan0204/github-repo-mcp ?"
3. Visualización de un archivo : Preguntar "Muéstrame el archivo README.md desde https://github.com/Ryan0204/github-repo-mcp "

Limitaciones

• Limitación de velocidad : sin autenticación, la API de GitHub tiene límites de velocidad estrictos (60 solicitudes por hora)
• Repositorios privados : solo se puede acceder a repositorios públicos a menos que se proporcione un token con los permisos adecuados
• Archivos binarios : el servidor detecta extensiones de archivos binarios comunes y no mostrará su contenido
• Archivos grandes : la API de GitHub tiene limitaciones en el tamaño de los archivos que se pueden recuperar

Solución de problemas

A continuación se presentan algunos problemas comunes y sus soluciones:

• Límite de velocidad excedido : configure un token de GitHub como se describe en la sección Configuración
• Comando no encontrado : asegúrese de que el paquete esté instalado globalmente
• Errores de conexión : Verifique su conexión a Internet y el estado de la API de GitHub

Si encuentra algún problema, verifique la salida en busca de mensajes de error o cree un problema en el repositorio de GitHub.

¡Que lo disfrutes! ☺️