PipeCD Docs

Buscar y recuperar la documentación oficial de

GitHub
7
Prueba este MCPPatrocinado

Documentación

Servidor MCP de Documentación de PipeCD

Un servidor MCP local para buscar documentación oficial de PipeCD.

Descripción General

Este servidor clona la documentación oficial de PipeCD desde GitHub y proporciona APIs simples de búsqueda de texto completo y recuperación de documentos a través del protocolo MCP.
La documentación se clona en un directorio temporal, y los archivos Markdown se indexan extrayendo sus títulos y contenido.

Uso

Requisitos Previos

  1. Crea un PAT con el alcance read:packages. Detalles

  2. Agrega la siguiente configuración a tu archivo .npmrc.

@pipe-cd:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=YOUR_TOKEN

Cursor

Instalación Rápida con Deeplink de Cursor

Para usuarios de Cursor, puedes instalar el servidor MCP con un solo clic usando el deeplink a continuación:

Install MCP Server

Esto configurará automáticamente el servidor MCP en tu configuración de Cursor. Después de hacer clic en el enlace, Cursor te pedirá que instales el servidor.

Instalación Usando npx

Agrega la siguiente configuración a tu mcp.json.

{
  "mcpServers": {
    "pipe-cd.docs-mcp-server": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "@pipe-cd/docs-mcp-server@latest"
      ], 
    }
  }
}

Herramientas

search_docs

Ejecuta una búsqueda de texto completo en la documentación de PipeCD.

  • Parámetros:
    • query: Palabras clave de búsqueda (separadas por espacios, búsqueda AND)
    • offset: Posición inicial para los resultados
    • limit: Número de resultados a devolver (predeterminado: 20)

read_docs

Devuelve el contenido de la página especificada.

  • Parámetros:
    • path: Ruta relativa del documento (después de "docs/content/en/")

Notas de Implementación

  • Utiliza sparse-checkout para minimizar el tamaño de la clonación y acelerar el proceso.
  • Los títulos se extraen del front matter de Markdown.
  • La lógica de búsqueda de search_docs es muy simple por ahora.

Contribuciones

Código de Conducta

PipeCD sigue el Código de Conducta de CNCF. Por favor, léelo para entender qué acciones son aceptables y cuáles no.

Participa

  • Slack: canal #pipecd en CNCF Slack para discusiones relacionadas con el desarrollo de PipeCD.
  • Reunión Comunitaria: Cada dos miércoles. Busca aquí.

Mejoras

  • Error:
    • Por favor, abre un Issue y describe el problema. O, abre un PR si es algo sencillo.
  • Mejora / Solicitud de Funcionalidad:
    • Para cambios pequeños, incluyendo documentación o adición de pruebas, por favor abre un PR.
    • Para nuevas funcionalidades o mejoras grandes, básicamente, por favor abre un Issue y discútelo allí antes de enviar un PR. No podemos aceptar todas las solicitudes en algunos casos.
  • Problema de seguridad:

Flujo de Publicación

  1. Ejecuta el flujo de trabajo prepare release especificando la nueva versión. Creará un PR para actualizar la versión.
  2. Revisa el PR y combínalo.
  3. Crea una Release en GitHub con una nueva etiqueta. Luego, el flujo de trabajo release package publicará un nuevo paquete npm.