CircleCI-Public/mcp-server-circleciPlease refer to the latest official releases for information GitHub Homepage

CircleCI MCP-Server - Eine professionelle Serverimplementierung, die speziell für das Modellkontextprotokoll entwickelt wurde, zur Integration von CircleCI-Entwicklungsabläufen.

Apache-2.0TypeScript 50CircleCI-Publicmcp-server-circleci Last Updated: 2025-06-23

CircleCI MCP Server Projektvorstellung

Projektübersicht

Der CircleCI MCP Server ist eine professionelle Serverimplementierung, die speziell für das Model Context Protocol (MCP) entwickelt wurde, um die Entwicklungsworkflows von CircleCI zu integrieren. Dieses Projekt dient als Brücke zwischen der CircleCI-Infrastruktur und dem Model Context Protocol und bietet ein verbessertes KI-gestütztes Entwicklungserlebnis.

Der Server ermöglicht es KI-Tools wie Cursor, Claude Code, Windsurf usw., Ihr Build-System zu verstehen. Er basiert auf dem Model Context Protocol (MCP), einem schlanken Standard, der es LLM-gesteuerten Agenten ermöglicht, strukturierte Daten von externen Systemen abzurufen.

Kernfunktionen

Hauptwerkzeuge und Funktionen

1. get_build_failure_logs

Ruft detaillierte Fehlerprotokolle von CircleCI-Builds ab. Dieses Tool unterstützt zwei Verwendungsweisen:

Verwendung einer CircleCI-URL:

Direkte Angabe der URL des fehlgeschlagenen Jobs oder der Pipeline-URL
Beispiel: "Hole die Protokolle von https://app.circleci.com/pipelines/github/org/repo/123"

Verwendung des lokalen Projektkontexts:

Arbeiten aus dem lokalen Arbeitsbereich durch Angabe der folgenden Informationen:
- Wurzelpfad des Arbeitsbereichs
- Git-Remote-URL
- Branch-Name
Beispiel: "Finde die neueste fehlgeschlagene Pipeline auf meinem aktuellen Branch"

Die zurückgegebenen formatierten Protokolle enthalten:

Jobname
Schrittweise Ausführungsdetails
Fehlermeldungen und Kontext

2. find_flaky_tests

Identifiziert instabile Tests in einem CircleCI-Projekt durch Analyse der Testausführungshistorie. Unterstützt zwei Verwendungsweisen:

Verwendung einer CircleCI-Projekt-URL:

Direkte Angabe der Projekt-URL von CircleCI
Beispiel: "Finde instabile Tests in https://app.circleci.com/pipelines/github/org/repo"

Verwendung des lokalen Projektkontexts:

Arbeiten aus dem lokalen Arbeitsbereich durch Angabe des Wurzelpfads des Arbeitsbereichs und der Git-Remote-URL

Gibt detaillierte Informationen zu instabilen Tests zurück, einschließlich:

Testname und Dateiposition
Fehlermeldungen und Kontext

3. get_latest_pipeline_status

Ruft den Status der neuesten Pipeline für einen bestimmten Branch ab. Das Tool gibt den formatierten Status der neuesten Pipeline zurück:

Workflow-Name und aktueller Status
Dauer jedes Workflows
Erstellungs- und Abschlusszeitstempel
Gesamt-Pipeline-Integrität

Beispielausgabe:

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

4. get_job_test_results

Ruft Testmetadaten für einen CircleCI-Job ab, sodass Sie Testergebnisse analysieren können, ohne die IDE zu verlassen.

Gibt detaillierte Informationen zu den Testergebnissen zurück:

Zusammenfassung aller Tests (Gesamtanzahl, Erfolge, Fehler)
Details zu fehlgeschlagenen Tests, einschließlich:
- Testname und -klasse
- Dateiposition
- Fehlermeldung
- Laufzeitdauer
Liste der erfolgreichen Tests mit Zeitinformationen

5. config_helper

Unterstützt bei CircleCI-Konfigurationsaufgaben und bietet Anleitungen und Validierung. Dieses Tool hilft Ihnen:

Validierung der CircleCI-Konfiguration:
- Überprüft Ihre .circleci/config.yml auf Syntax- und semantische Fehler
- Beispiel: "Validiere meine CircleCI-Konfiguration"

Bietet:

Detaillierte Validierungsergebnisse
Konfigurationsvorschläge

6. create_prompt_template

Generiert strukturierte Prompt-Vorlagen basierend auf funktionalen Anforderungen für KI-gestützte Anwendungen. Dieses Tool:

Konvertiert funktionale Anforderungen in strukturierte Prompts:
- Wandelt Benutzeranforderungen in optimierte Prompt-Vorlagen um
- Beispiel: "Erstelle eine Prompt-Vorlage zum Generieren von Gute-Nacht-Geschichten nach Alter und Thema"

7. recommend_prompt_template_tests

Generiert Testfälle für Prompt-Vorlagen, um sicherzustellen, dass sie die erwarteten Ergebnisse liefern.

Installation und Konfiguration

Systemanforderungen

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

Unterstützte IDEs und Tools

Cursor IDE

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

{
  "mcpServers": {
    "circleci-mcp-server": {
      "command": "npx",
      "args": ["-y", "@circleci/mcp-server-circleci"],
      "env": {
        "CIRCLECI_TOKEN": "your-circleci-token",
        "CIRCLECI_BASE_URL": "https://circleci.com" // Optional - nur für lokal bereitgestellte Kunden erforderlich
      }
    }
  }
}

VS Code

Installieren Sie den CircleCI MCP Server in .vscode/mcp.json:

{
  // 💡 Eingabe wird beim ersten Serverstart abgefragt und dann sicher von VS Code gespeichert
  "inputs": [
    {
      "type": "promptString",
      "id": "circleci-token",
      "description": "CircleCI API Token",
      "password": true
    }
  ],
  "servers": {
    "circleci-mcp-server": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@circleci/mcp-server-circleci"],
      "env": {
        "CIRCLECI_TOKEN": "${input:circleci-token}"
      }
    }
  }
}

Claude Desktop

Fügen Sie Folgendes zu Ihrer claude_desktop_config.json hinzu:

{
  "mcpServers": {
    "circleci-mcp-server": {
      "command": "npx",
      "args": ["-y", "@circleci/mcp-server-circleci"],
      "env": {
        "CIRCLECI_TOKEN": "your-circleci-token",
        "CIRCLECI_BASE_URL": "https://circleci.com" // Optional - nur für lokal bereitgestellte Kunden erforderlich
      }
    }
  }
}

Konfigurationsdateispeicherort:

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

Claude Code

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

claude mcp add circleci-mcp-server -e CIRCLECI_TOKEN=your-circleci-token -- npx -y @circleci/mcp-server-circleci

Windsurf

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

{
  "mcpServers": {
    "circleci-mcp-server": {
      "command": "npx",
      "args": ["-y", "@circleci/mcp-server-circleci"],
      "env": {
        "CIRCLECI_TOKEN": "your-circleci-token",
        "CIRCLECI_BASE_URL": "https://circleci.com" // Optional - nur für lokal bereitgestellte Kunden erforderlich
      }
    }
  }
}

Automatische Installation

Installieren Sie den CircleCI MCP Server automatisch für Claude Desktop über Smithery:

npx -y @smithery/cli install @CircleCI-Public/mcp-server-circleci --client claude

Entwicklung und Beitrag

Lokale Entwicklungsumgebung

Repository klonen:

git clone https://github.com/CircleCI-Public/mcp-server-circleci.git
cd mcp-server-circleci

Abhängigkeiten installieren:

pnpm install

Projekt bauen:

pnpm build

Entwicklung mit dem MCP Inspector

Der einfachste Weg, den MCP Server zu iterieren, ist die Verwendung des MCP Inspectors.

Entwicklungsserver starten:

pnpm watch # In einem Terminal am Laufen halten

Inspector in einem separaten Terminal starten:

pnpm inspector

Umgebung konfigurieren:
- Fügen Sie Ihren CIRCLECI_TOKEN im Abschnitt Umgebungsvariablen der Inspector-UI hinzu
- Der Token benötigt Leseberechtigungen für Ihre CircleCI-Projekte
- Optional können Sie Ihre CircleCI-Basis-URL festlegen, die standardmäßig auf https://circleci.com gesetzt ist

Tests

Testsuite ausführen:

pnpm test

Tests im Watch-Modus während der Entwicklung ausführen:

pnpm test:watch

Anwendungsfälle

Dieses Tool ist besonders nützlich für:

Debuggen fehlgeschlagener Builds
Analysieren von Testfehlern
Untersuchen von Bereitstellungsproblemen
Schneller Zugriff auf Build-Protokolle, ohne die IDE zu verlassen
Überprüfen des Status der neuesten Pipelines
Identifizieren unzuverlässiger Tests in der Testsuite
Treffen datengestützter Entscheidungen zur Testverbesserung

Projektvorteile

Der CircleCI MCP Server wurde entwickelt, um die realen Momente im Entwicklungslebenszyklus zu unterstützen. Egal, ob Sie einen fehlgeschlagenen Build überprüfen, eine fehlgeschlagene Bereitstellung debuggen oder einen kritischen Branch überwachen, er hilft Ihrem Assistenten, Fehler in Sekundenschnelle zu verstehen und Korrekturen vorzuschlagen – ohne Kontextwechsel.

Durch die Integration dieses MCP Servers können Entwickler:

Mit CircleCI in natürlicher Sprache interagieren
Build-Informationen in ihrer vertrauten Entwicklungsumgebung abrufen
CI/CD-Probleme schnell diagnostizieren und beheben
Die Effizienz ihrer Entwicklungsworkflows steigern