mcp-server-circleci

Servidor MCP de CircleCI

El Protocolo de Contexto de Modelo (MCP) es un nuevo protocolo estandarizado para gestionar el contexto entre grandes modelos de lenguaje (LLM) y sistemas externos. En este repositorio, ofrecemos un servidor MCP para CircleCI .

Esto le permite usar Cursor IDE, o cualquier cliente MCP, para usar lenguaje natural para lograr cosas con CircleCI, por ejemplo:

• Find the latest failed pipeline on my branch and get logshttps://github.com/CircleCI-Public/mcp-server-circleci/wiki#circleci-mcp-server-with-cursor-ide

https://github.com/user-attachments/assets/3c765985-8827-442a-a8dc-5069e01edb74

Requisitos

• Gestor de paquetes pnpm: Más información
• Node.js >= v18.0.0
• Token de la API de CircleCI: puedes generar uno a través de CircleCI. Obtén más información o haz clic aquí para acceder rápidamente.

Instalación

Instalación mediante herrería

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

Cursor

Agregue lo siguiente a la configuración MCP de su cursor:

Consulte la guía a continuación para obtener más información sobre el uso de servidores MCP con cursor: https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers

Escritorio de Claude

Agregue lo siguiente a su claude_desktop_config.json:

Para encontrar/crear este archivo, primero abra la configuración de escritorio de Claude. Luego, haga clic en "Desarrollador" en la barra izquierda del panel de Configuración y, a continuación, en "Editar configuración".

Esto creará un archivo de configuración en:

• macOS: ~/Biblioteca/Soporte de aplicaciones/Claude/claude_desktop_config.json
• Ventanas: %APPDATA%\Claude\claude_desktop_config.json

Consulte la guía a continuación para obtener más información sobre el uso de servidores MCP con Claude Desktop: https://modelcontextprotocol.io/quickstart/user

Claude Code

Después de instalar Claude Code, ejecute el siguiente comando:

Consulte la guía a continuación para obtener más información sobre el uso de servidores MCP con Claude Code: https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/tutorials#set-up-model-context-protocol-mcp

Código VS

Agregue el servidor MCP a su configuración.json en mcp -> servers :

Consulte la guía a continuación para obtener más información sobre el uso de servidores MCP con VS Code: https://code.visualstudio.com/docs/copilot/chat/mcp-servers

Windsurf

Agregue lo siguiente a su windsurf mcp_config.json:

Consulte la guía a continuación para obtener más información sobre el uso de servidores MCP con Windsurf: https://docs.windsurf.com/windsurf/mcp

Características

Herramientas compatibles

• get_build_failure_logsRecupera registros detallados de errores de las compilaciones de CircleCI. Esta herramienta se puede usar de dos maneras:
  1. Uso de las URL de CircleCI:
     • Proporcione una URL de trabajo fallido o una URL de canalización directamente
     • Ejemplo: "Obtener registros de https://app.circleci.com/pipelines/github/org/repo/123 "
  2. Uso del contexto del proyecto local:
     • Trabaja desde su espacio de trabajo local proporcionando:
       • Ruta raíz del espacio de trabajo
       • URL remota de Git
       • Nombre de la sucursal
     • Ejemplo: "Buscar el último pipeline fallido en mi rama actual"

  La herramienta devuelve registros formateados que incluyen:

  • Nombres de trabajos
  • Detalles de ejecución paso a paso
  • Mensajes de error y contexto

  Esto es particularmente útil para:

  • Depuración de compilaciones fallidas
  • Análisis de fallos de pruebas
  • Investigación de problemas de implementación
  • Acceso rápido a los registros de compilación sin salir de su IDE
• find_flaky_testsIdentifica pruebas inestables en tu proyecto CircleCI analizando el historial de ejecución de pruebas. Esto aprovecha la función de detección de pruebas inestables que se describe aquí: https://circleci.com/blog/introducing-test-insights-with-flaky-test-detection/#flaky-test-detectionEsta herramienta se puede utilizar de dos maneras:
  1. Usando la URL del proyecto CircleCI:
     • Proporcione la URL del proyecto directamente desde CircleCI
     • Ejemplo: "Encuentra pruebas inestables en https://app.circleci.com/pipelines/github/org/repo "
  2. Uso del contexto del proyecto local:
     • Trabaja desde su espacio de trabajo local proporcionando:
       • Ruta raíz del espacio de trabajo
       • URL remota de Git
     • Ejemplo: "Encontrar pruebas defectuosas en mi proyecto actual"

  La herramienta devuelve información detallada sobre pruebas inestables, que incluye:

  • Nombres de prueba y ubicaciones de archivos
  • Mensajes y contextos de fallo

  Esto le ayudará a:

  • Identifique pruebas no confiables en su conjunto de pruebas
  • Obtenga un contexto detallado sobre los fallos de las pruebas
  • Tome decisiones basadas en datos sobre mejoras en las pruebas
• config_helperAsiste en las tareas de configuración de CircleCI proporcionando orientación y validación. Esta herramienta le ayuda a:
  1. Validar la configuración de CircleCI:
     • Comprueba su .circleci/config.yml en busca de errores de sintaxis y semántica
     • Ejemplo: "Validar mi configuración de CircleCI"

  La herramienta proporciona:

  • Resultados detallados de la validación
  • Recomendaciones de configuración

  Esto le ayudará a:

  • Detectar errores de configuración antes de enviar
  • Aprenda las mejores prácticas de configuración de CircleCI
  • Solucionar problemas de configuración
  • Implementar correctamente las funciones de CircleCI

Desarrollo

Empezando

1. Clonar el repositorio:
   git clone https://github.com/CircleCI-Public/mcp-server-circleci.git cd mcp-server-circleci
2. Instalar dependencias:
   pnpm install
3. Construir el proyecto:
   pnpm build

Desarrollo con MCP Inspector

La forma más sencilla de iterar en el servidor MCP es mediante el inspector MCP. Puede obtener más información sobre el inspector MCP en https://modelcontextprotocol.io/docs/tools/inspector

1. Inicie el servidor de desarrollo:
   pnpm watch # Keep this running in one terminal
2. En una terminal separada, inicie el inspector:
   pnpm inspector
3. Configurar el entorno:
   • Agregue su CIRCLECI_TOKEN a la sección Variables de entorno en la interfaz de usuario del inspector
   • El token necesita acceso de lectura a sus proyectos CircleCI
   • Opcionalmente, puede configurar la URL base de CircleCI. El valor predeterminado es https//circleci.com

Pruebas

• Ejecute el conjunto de pruebas:
  pnpm test
• Ejecutar pruebas en modo de observación durante el desarrollo:
  pnpm test:watch

Para obtener pautas de contribución más detalladas, consulte CONTRIBUTING.md