godoc-mcp

Descripción general

godoc-mcp es un servidor de Protocolo de Contexto de Modelo (MCP) que proporciona acceso eficiente a la documentación de Go. Ayuda a los LLM a comprender los proyectos de Go, proporcionando acceso directo a la documentación de los paquetes sin necesidad de leer archivos fuente completos. godoc-mcp puede mejorar enormemente el rendimiento del desarrollo en Go con LLM, reduciendo sustancialmente la cantidad de tokens necesarios para comprender y utilizar los paquetes de Go.

Empezando

¿Por qué utilizar godoc-mcp?

En una oración: godoc-mcp proporciona una forma más eficiente para que los LLM comprendan los proyectos de Go.

Los métodos tradicionales de lectura de archivos requieren que los LLM procesen archivos fuente completos (a menudo muchos archivos) para comprender un solo paquete. godoc-mcp ofrece varias ventajas:

1. Eficiencia del token : devuelve solo la documentación esencial, lo que reduce significativamente el uso del token
2. Información estructurada : proporciona documentación oficial del paquete en un formato coherente y bien estructurado.
3. Navegación del proyecto : el manejo inteligente de las estructuras del proyecto ayuda a los LLM a comprender proyectos con múltiples paquetes.
4. Listo para integración : funciona junto con otros servidores MCP, lo que permite un análisis de código detallado y de alto nivel.
5. Rendimiento : el almacenamiento en caché y el uso optimizado de tokens hacen de godoc-mcp una herramienta rápida y eficiente para el desarrollo de Go
6. Local : No requiere conexión a Internet para acceder a la documentación.

Con godoc-mcp , un LLM puede obtener con precisión la información que necesita sin tener que leer archivos fuente completos. Estos son los diferentes niveles de detalle que un LLM puede obtener.

• Documentación para un símbolo exportado
• La fuente completa de un símbolo
• Una lista de todos los símbolos exportados (la documentación concisa)
• Una lista de todos los símbolos, incluidos los símbolos no exportados
• La documentación completa de un paquete
• El código fuente completo de un paquete

Esto hace que godoc-mcp sea una herramienta esencial para los desarrolladores de Go que usan LLM al permitirles comprender mucho más, y con más detalle, sobre el contexto de lo que era posible antes en cualquier lenguaje de programación.

Características

El servidor hará lo siguiente:

1. Para directorios con archivos Go: Devolver la documentación del paquete
2. Para directorios sin archivos Go: enumerar los paquetes Go disponibles en los subdirectorios
3. Para rutas de importación: Devuelve la documentación de la biblioteca estándar o del paquete de terceros

• Acceso eficiente a la documentación : recupera la documentación oficial de Go con un uso mínimo de tokens
• Detección inteligente de paquetes : cuando se apunta a un directorio sin archivos Go, enumera los paquetes Go disponibles en subdirectorios
• Soporte de ruta flexible :
  • Rutas de archivos locales (por ejemplo, "/ruta/completa/a/mipaquete")
  • Rutas de importación (por ejemplo, "io", "github.com/user/repo")
• Contexto del módulo automático :
  • Crea proyectos Go temporales cuando sea necesario
  • Configura automáticamente el contexto del módulo para paquetes externos
  • No se requiere configuración manual de módulos para ninguna documentación del paquete
  • Se encarga de la limpieza de proyectos temporales.
• Compatible con módulos : admite documentación para paquetes de terceros a través del contexto del directorio de trabajo (es decir, ejecutará go doc desde el directorio de trabajo)
• Rendimiento optimizado :
  • Almacenamiento en caché de respuestas integrado
  • Uso eficiente de tokens mediante la recuperación de documentación enfocada
  • Metadatos sobre el tamaño de las respuestas
  • Manejo inteligente de la biblioteca estándar frente a paquetes externos

Ejemplos

Además de proporcionar documentación mientras se trabaja en tareas de codificación, godoc-mcp también puede usarse para explorar proyectos y paquetes de Go. Aquí hay algunos ejemplos de indicaciones generales:

Comprensión del proyecto

Estoy viendo un proyecto de Go en /ruta/a/algún/proyecto. ¿Qué paquetes contiene y qué hacen?

Comprensión de la interfaz del paquete

¿Qué interfaces ofrece el paquete io? Me interesa especialmente todo lo relacionado con la lectura.

Guía de implementación

Necesito implementar la interfaz io.Reader. Muéstrame su documentación y cualquier tipo relacionado que deba conocer.

Uso de la API

Muéstrame la documentación del tipo de recurso en la ruta a algún proyecto. Necesito saber cómo crearlo y usarlo.

Exploración de la biblioteca

Estoy en la ruta de un proyecto que usa github.com/gorilla/mux. Muéstrame la documentación del tipo de enrutador.

Descubrimiento de métodos

¿Qué métodos están disponibles para el tipo http.Request? Estoy trabajando con controladores HTTP de la biblioteca estándar.

Aprendizaje enfocado

"Explique cómo configurar el tipo de Servidor en el paquete /ruta/al/proyecto/servidor".

Navegación de paquetes

Estoy en un nuevo directorio de proyecto Go y veo varios paquetes. ¿Puedes mostrarme qué hace cada uno?

Uso

Para agregar a la aplicación de escritorio de Claude:

Cuando se conecta a un LLM compatible con MCP (como Claude), godoc-mcp proporciona a la herramienta get_doc los siguientes parámetros:

• path : Ruta al paquete o archivo Go (ruta de importación o ruta de archivo)
• target (opcional): Símbolo específico para documentar (función, tipo, etc.)
• cmd_flags (opcional): indicadores de comando adicionales de go doc
• working_dir (opcional): Directorio de trabajo para la documentación compatible con módulos (si no se proporciona, se creará automáticamente un proyecto temporal)

Valores avanzados cmd_flags que un LLM puede aprovechar:

• -all : Mostrar toda la documentación del paquete, excluyendo los símbolos no exportados
• -u : Mostrar símbolos no exportados
• -src : Mostrar el código fuente en lugar de la documentación

Solución de problemas

• Para las rutas locales, asegúrese de que contengan archivos fuente de Go o apunten a directorios que contengan paquetes de Go
• Si ve errores relacionados con el módulo, asegúrese de que las variables de entorno GOPATH y GOMODCACHE estén configuradas correctamente en la configuración del servidor MCP.
• El servidor maneja automáticamente el contexto del módulo para paquetes externos, pero aún puede proporcionar un working_dir específico si es necesario para casos especiales.

Licencia

Este proyecto está licenciado bajo la licencia MIT: consulte el archivo de LICENCIA para obtener más detalles.