mcp-server-circleci

CircleCI MCP-Server

Model Context Protocol (MCP) ist ein neues, standardisiertes Protokoll zur Verwaltung des Kontexts zwischen großen Sprachmodellen (LLMs) und externen Systemen. In diesem Repository stellen wir einen MCP-Server für CircleCI bereit.

Auf diese Weise können Sie Cursor IDE oder einen beliebigen MCP-Client verwenden, um mithilfe natürlicher Sprache Dinge mit CircleCI zu erreichen, z. B.:

• 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

Anforderungen

• pnpm-Paketmanager – Mehr erfahren
• Node.js >= v18.0.0
• CircleCI API-Token – Sie können einen über CircleCI generieren. Erfahren Sie mehr oder klicken Sie hier für schnellen Zugriff.

Installation

Cursor

Fügen Sie Ihrer Cursor-MCP-Konfiguration Folgendes hinzu:

Weitere Informationen zur Verwendung von MCP-Servern mit Cursor finden Sie in der folgenden Anleitung: https://docs.cursor.com/context/model-context-protocol#configuring-mcp-servers

VS Code

So installieren Sie CircleCI MCP Server für VS Code in .vscode/mcp.json

Weitere Informationen zur Verwendung von MCP-Servern mit VS Code finden Sie in der folgenden Anleitung: https://code.visualstudio.com/docs/copilot/chat/mcp-servers

Claude Desktop

Fügen Sie Ihrer claude_desktop_config.json Folgendes hinzu:

Um diese Datei zu finden/erstellen, öffnen Sie zunächst die Claude-Desktop-Einstellungen. Klicken Sie dann links im Einstellungsbereich auf „Entwickler“ und anschließend auf „Konfiguration bearbeiten“.

Dadurch wird eine Konfigurationsdatei erstellt unter:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json

Weitere Informationen zur Verwendung von MCP-Servern mit Claude Desktop finden Sie in der folgenden Anleitung: https://modelcontextprotocol.io/quickstart/user

Claude Code

Führen Sie nach der Installation von Claude Code den folgenden Befehl aus:

Weitere Informationen zur Verwendung von MCP-Servern mit Claude Code finden Sie in der folgenden Anleitung: https://docs.anthropic.com/en/docs/agents-and-tools/claude-code/tutorials#set-up-model-context-protocol-mcp

Windsurf

Fügen Sie Ihrer Windsurf-mcp_config.json Folgendes hinzu:

Installation über Smithery

So installieren Sie CircleCI MCP Server für Claude Desktop automatisch über Smithery :

Weitere Informationen zur Verwendung von MCP-Servern mit Windsurf finden Sie in der folgenden Anleitung: https://docs.windsurf.com/windsurf/mcp

Merkmale

Unterstützte Tools

• get_build_failure_logsRuft detaillierte Fehlerprotokolle von CircleCI-Builds ab. Dieses Tool kann auf zwei Arten verwendet werden:
  1. Verwenden von CircleCI-URLs:
     • Geben Sie die URL eines fehlgeschlagenen Jobs oder einer Pipeline direkt an
     • Beispiel: „Protokolle abrufen von https://app.circleci.com/pipelines/github/org/repo/123 “
  2. Lokalen Projektkontext verwenden:
     • Funktioniert von Ihrem lokalen Arbeitsbereich aus, indem Folgendes bereitgestellt wird:
       • Stammpfad des Arbeitsbereichs
       • Git-Remote-URL
       • Filialname
     • Beispiel: „Suchen Sie die letzte fehlgeschlagene Pipeline in meinem aktuellen Zweig.“

  Das Tool gibt formatierte Protokolle zurück, darunter:

  • Jobnamen
  • Schrittweise Ausführungsdetails
  • Fehlermeldungen und Kontext

  Dies ist besonders nützlich für:

  • Debuggen fehlgeschlagener Builds
  • Analysieren von Testfehlern
  • Untersuchen von Bereitstellungsproblemen
  • Schneller Zugriff auf Build-Protokolle, ohne Ihre IDE zu verlassen
• find_flaky_testsIdentifiziert fehlerhafte Tests in Ihrem CircleCI-Projekt durch Analyse des Testausführungsverlaufs. Dies nutzt die hier beschriebene Funktion zur Erkennung fehlerhafter Tests: https://circleci.com/blog/introducing-test-insights-with-flaky-test-detection/#flaky-test-detectionDieses Tool kann auf zwei Arten verwendet werden:
  1. Verwenden der CircleCI-Projekt-URL:
     • Geben Sie die Projekt-URL direkt von CircleCI an
     • Beispiel: „Finden Sie fehlerhafte Tests in https://app.circleci.com/pipelines/github/org/repo “
  2. Lokalen Projektkontext verwenden:
     • Funktioniert von Ihrem lokalen Arbeitsbereich aus, indem Folgendes bereitgestellt wird:
       • Stammpfad des Arbeitsbereichs
       • Git-Remote-URL
     • Beispiel: „Finden Sie fehlerhafte Tests in meinem aktuellen Projekt.“

  Das Tool gibt detaillierte Informationen zu fehlerhaften Tests zurück, darunter:

  • Testnamen und Dateispeicherorte
  • Fehlermeldungen und Kontexte

  Dies hilft Ihnen:

  • Identifizieren Sie unzuverlässige Tests in Ihrer Testsuite
  • Erhalten Sie detaillierten Kontext zu Testfehlern
  • Treffen Sie datenbasierte Entscheidungen zur Testverbesserung
• get_latest_pipeline_statusRuft den Status der neuesten Pipeline für einen bestimmten Zweig ab. Dieses Tool kann auf zwei Arten verwendet werden:
  1. Verwenden der CircleCI-Projekt-URL:
     • Geben Sie die Projekt-URL direkt von CircleCI an
     • Beispiel: „Status der neuesten Pipeline für https://app.circleci.com/pipelines/github/org/repo abrufen“
  2. Lokalen Projektkontext verwenden:
     • Funktioniert von Ihrem lokalen Arbeitsbereich aus, indem Folgendes bereitgestellt wird:
       • Stammpfad des Arbeitsbereichs
       • Git-Remote-URL
       • Filialname
     • Beispiel: „Status der neuesten Pipeline für mein aktuelles Projekt abrufen“

  Das Tool gibt einen formatierten Status der neuesten Pipeline zurück:

  • Workflow-Namen und ihr aktueller Status
  • Dauer jedes Workflows
  • Zeitstempel für Erstellung und Abschluss
  • Gesamtzustand der Pipeline

  Beispielausgabe:

  --- Workflow: build Status: success Duration: 5 minutes Created: 4/20/2025, 10:15:30 AM Stopped: 4/20/2025, 10:20:45 AM --- Workflow: test Status: running Duration: unknown Created: 4/20/2025, 10:21:00 AM Stopped: in progress

  Dies ist besonders nützlich für:

  • Überprüfen des Status der neuesten Pipeline
  • Abrufen des Status der neuesten Pipeline für einen bestimmten Zweig
  • Schnelles Überprüfen des Status der neuesten Pipeline, ohne Ihre IDE zu verlassen
• get_job_test_resultsRuft Testmetadaten für CircleCI-Jobs ab und ermöglicht Ihnen die Analyse von Testergebnissen, ohne Ihre IDE zu verlassen. Dieses Tool kann auf zwei Arten verwendet werden:
  1. Verwenden der CircleCI-URL (empfohlen):
     • Geben Sie eine CircleCI-URL in einem dieser Formate an:
       • Job-URL: " https://app.circleci.com/pipelines/github/org/repo/123/workflows/abc-def/jobs/789 "
       • Workflow-URL: " https://app.circleci.com/pipelines/github/org/repo/123/workflows/abc-def "
       • Pipeline-URL: " https://app.circleci.com/pipelines/github/org/repo/123 "
     • Beispiel: „Testergebnisse abrufen für https://app.circleci.com/pipelines/github/org/repo/123/workflows/abc-def “
  2. Lokalen Projektkontext verwenden:
     • Funktioniert von Ihrem lokalen Arbeitsbereich aus, indem Folgendes bereitgestellt wird:
       • Stammpfad des Arbeitsbereichs
       • Git-Remote-URL
       • Filialname
     • Beispiel: „Testergebnisse für mein aktuelles Projekt im Hauptzweig abrufen“

  Das Tool gibt detaillierte Informationen zu den Testergebnissen zurück:

  • Zusammenfassung aller Tests (Gesamt, Erfolgreich, Nicht bestanden)
  • Detaillierte Informationen zu fehlgeschlagenen Tests, einschließlich:
    • Testname und Klasse
    • Dateispeicherort
    • Fehlermeldungen
    • Laufzeit
  • Liste erfolgreicher Tests mit Zeitinformationen

  Dies ist besonders nützlich für:

  • Schnelle Analyse von Testfehlern ohne Besuch der CircleCI-Web-Benutzeroberfläche
  • Erkennen von Mustern bei Testfehlern
  • Finden langsamer Tests, die möglicherweise optimiert werden müssen
  • Überprüfen der Testabdeckung in Ihrem gesamten Projekt
  • Fehlerbehebung bei fehlerhaften Tests

  Hinweis: Das Tool erfordert, dass die Testmetadaten in Ihrer CircleCI-Konfiguration korrekt konfiguriert sind. Weitere Informationen zum Einrichten der Testmetadatenerfassung finden Sie unter: https://circleci.com/docs/collect-test-data/

• config_helperUnterstützt CircleCI-Konfigurationsaufgaben durch Anleitung und Validierung. Dieses Tool hilft Ihnen:
  1. CircleCI-Konfiguration validieren:
     • Überprüft Ihre .circleci/config.yml auf Syntax- und Semantikfehler
     • Beispiel: „Meine CircleCI-Konfiguration validieren“

  Das Tool bietet:

  • Detaillierte Validierungsergebnisse
  • Konfigurationsempfehlungen

  Dies hilft Ihnen:

  • Fangen Sie Konfigurationsfehler ab, bevor Sie pushen
  • Erfahren Sie mehr über die Best Practices für die CircleCI-Konfiguration
  • Beheben von Konfigurationsproblemen
  • CircleCI-Funktionen richtig implementieren
• create_prompt_templateHilft bei der Erstellung strukturierter Eingabevorlagen für KI-gestützte Anwendungen basierend auf Funktionsanforderungen. Dieses Tool:
  1. Wandelt Funktionsanforderungen in strukturierte Eingabeaufforderungen um:
     • Wandelt Benutzeranforderungen in optimierte Eingabevorlagen um
     • Beispiel: „Erstellen Sie eine Vorlage für die Erstellung von Gutenachtgeschichten nach Alter und Thema.“

  Das Tool bietet:

  • Eine strukturierte Eingabeaufforderungsvorlage
  • Ein Kontextschema, das die erforderlichen Eingabeparameter definiert

  Dies hilft Ihnen:

  • Erstellen Sie effektive Eingabeaufforderungen für KI-Anwendungen
  • Standardisieren Sie Eingabeparameter für konsistente Ergebnisse
  • Erstellen Sie robuste KI-gestützte Funktionen
• recommend_prompt_template_testsGeneriert Testfälle für Eingabevorlagen, um sicherzustellen, dass sie die erwarteten Ergebnisse liefern. Dieses Tool:
  1. Bietet Testfälle für Eingabeaufforderungsvorlagen:
     • Erstellt verschiedene Testszenarien basierend auf Ihrer Eingabeaufforderungsvorlage und Ihrem Kontextschema
     • Beispiel: „Tests für meine Vorlage für Gutenachtgeschichten erstellen“

  Das Tool bietet:

  • Eine Reihe empfohlener Testfälle
  • Verschiedene Parameterkombinationen zum Testen der Vorlagenrobustheit

  Dies hilft Ihnen:

  • Überprüfen der Funktionalität der Eingabeaufforderungsvorlage
  • Gewährleisten Sie konsistente KI-Reaktionen über alle Eingaben hinweg
  • Identifizieren Sie Randfälle und potenzielle Probleme
  • Verbessern Sie die Gesamtqualität Ihrer KI-Anwendungen

Entwicklung

Erste Schritte

1. Klonen Sie das Repository:
   git clone https://github.com/CircleCI-Public/mcp-server-circleci.git cd mcp-server-circleci
2. Installieren Sie Abhängigkeiten:
   pnpm install
3. Erstellen Sie das Projekt:
   pnpm build

Entwicklung mit MCP Inspector

Die einfachste Möglichkeit, auf dem MCP-Server zu iterieren, ist die Verwendung des MCP-Inspektors. Weitere Informationen zum MCP-Inspektor finden Sie unter https://modelcontextprotocol.io/docs/tools/inspector

1. Starten Sie den Entwicklungsserver:
   pnpm watch # Keep this running in one terminal
2. Starten Sie den Inspector in einem separaten Terminal:
   pnpm inspector
3. Konfigurieren Sie die Umgebung:
   • Fügen Sie Ihren CIRCLECI_TOKEN zum Abschnitt „Umgebungsvariablen“ in der Inspektor-Benutzeroberfläche hinzu
   • Das Token benötigt Lesezugriff auf Ihre CircleCI-Projekte
   • Optional können Sie Ihre CircleCI-Basis-URL festlegen. Standardmäßig ist https//circleci.com

Testen

• Führen Sie die Testsuite aus:
  pnpm test
• Führen Sie während der Entwicklung Tests im Überwachungsmodus aus:
  pnpm test:watch

Ausführlichere Richtlinien für Beiträge finden Sie unter CONTRIBUTING.md