Bitrise MCP Server

Bitrise MCP Server

MCP-Server für die Bitrise-API, der App-Verwaltung, Build-Vorgänge, Artefaktverwaltung und mehr ermöglicht.

Merkmale

• Umfassender API-Zugriff : Zugriff auf Bitrise-APIs, einschließlich Apps, Builds, Artefakte und mehr.
• Authentifizierungsunterstützung : Sicherer API-Token-basierter Zugriff auf Bitrise-Ressourcen.
• Detaillierte Dokumentation : Gut dokumentierte Tools mit Parameterbeschreibungen.

Aufstellen

Umgebungs-Setup

• Python 3.12.6 erforderlich (Sie können pyenv verwenden).
• Verwenden Sie UV für die Abhängigkeitsverwaltung.

Beispiel zum Einrichten der Umgebung

Weitere Optionen finden Sie in der offiziellen Dokumentation zu UV und Pylint.

Bitrise API-Token

Erstellen Sie ein Bitrise-API-Token :

• Gehen Sie zu Ihren Bitrise-Kontoeinstellungen/Sicherheit .
• Navigieren Sie zum Abschnitt „Persönliche Zugriffstoken“.
• Kopieren Sie das generierte Token.

Verwendung mit Claude Desktop

In dieser Anleitung wird Claude Desktop als MCP-Client verwendet. Sie können jedoch jeden anderen MCP-kompatiblen Client verwenden und die folgenden Konfigurationsoptionen an Ihren bevorzugten Client anpassen.

Öffnen Sie die Claude-Einstellungen und navigieren Sie dann zur Registerkarte „Entwickler“.

Klicken Sie auf Konfiguration bearbeiten . Dadurch wird eine Konfigurationsdatei namens claude_desktop_config.json erstellt. Öffnen Sie diese Datei mit Ihrem bevorzugten Editor und fügen Sie den Bitrise MCP-Server hinzu:

Speichern Sie die Konfigurationsdatei und starten Sie Claude Desktop neu. Wenn alles korrekt eingerichtet ist, sollte neben dem Nachrichteneditor ein Hammersymbol angezeigt werden.

Verwendung mit VS Code

Befolgen Sie die offizielle Anleitung , um den Agentenmodus im Copilot-Chat zu aktivieren.

Öffnen Sie dann settings.json von VSCode (entweder die Einstellungen auf Arbeitsbereichsebene oder auf Benutzerebene) und fügen Sie die Bitrise MCP-Serverkonfiguration unter dem Schlüssel mcp.servers und die Eingabe des Arbeitsbereichstokens unter dem Schlüssel mcp.inputs hinzu:

Speichern Sie die Konfiguration. VS Code erkennt die Änderung automatisch und lädt die Tools in Copilot Chat.

Erweiterte Konfiguration

Sie können die Anzahl der für den MCP-Client verfügbaren Tools begrenzen. Dies ist nützlich, wenn Sie die Token-Nutzung optimieren möchten oder Ihr MCP-Client eine begrenzte Anzahl von Tools hat.

Tools werden nach ihrer „API-Gruppe“ gruppiert. Sie können die Gruppen, die Sie als Tools verfügbar machen möchten, übergeben. Mögliche Werte: apps, builds, workspaces, webhooks, build-artifacts, group-roles, cache-items, pipelines, account, read-only, release-management .

Wir empfehlen, die API-Gruppe „ release-management separat zu verwenden, um Verwechslungen mit der API-Gruppe „ apps zu vermeiden.

Beispielkonfiguration:

Werkzeuge

Apps

1. list_apps
   • Listen Sie alle für das authentifizierte Konto verfügbaren Apps auf
   • Argumente:
     • sort_by (optional): Reihenfolge der Apps: last_build_at (Standard) oder created_at
     • next (optional): Slug der ersten App in der Antwort
     • limit (optional): Maximale Anzahl von Elementen pro Seite (Standard: 50)
2. register_app
   • Fügen Sie Bitrise eine neue App hinzu
   • Argumente:
     • repo_url : Repository-URL
     • is_public : Ob die Sichtbarkeit der App-Builds „öffentlich“ ist
     • organization_slug : Die Organisation (auch Arbeitsbereich genannt), zu der die App hinzugefügt werden soll
     • project_type (optional): Projekttyp (iOS, Android usw.)
     • provider (optional): github
3. finish_bitrise_app
   • Schließen Sie die Einrichtung einer Bitrise-App ab
   • Argumente:
     • app_slug : Der Slug der Bitrise-App, für die die Einrichtung abgeschlossen werden soll
     • project_type (optional): Der Projekttyp (z. B. Android, iOS, Flutter usw.)
     • stack_id (optional): Die für die App zu verwendende Stack-ID
     • mode (optional): Der Setup-Modus
     • config (optional): Die für die App zu verwendende Konfiguration
4. get_app
   • Details zu einer bestimmten App abrufen
   • Argumente:
     • app_slug : Kennung der Bitrise-App
5. delete_app
   • Löschen einer App aus Bitrise
   • Argumente:
     • app_slug : Kennung der Bitrise-App
6. update_app
   • Aktualisieren einer App
   • Argumente:
     • app_slug : Kennung der Bitrise-App
     • is_public : Ob die Sichtbarkeit der App-Builds „öffentlich“ ist
     • project_type : Projekttyp
     • provider : Repository-Anbieter
     • repo_url : Repository-URL
7. get_bitrise_yml
   • Holen Sie sich die aktuelle Bitrise YML-Konfigurationsdatei einer bestimmten Bitrise-App
   • Argumente:
     • app_slug : Kennung der Bitrise-App
8. update_bitrise_yml
   • Aktualisieren Sie die Bitrise YML-Konfigurationsdatei einer bestimmten Bitrise-App
   • Argumente:
     • app_slug : Kennung der Bitrise-App
     • bitrise_yml_as_json : Der neue Inhalt der Bitrise YML-Konfigurationsdatei
9. list_branches
   • Listet die Zweige mit vorhandenen Builds des Repository einer App auf
   • Argumente:
     • app_slug : Kennung der Bitrise-App
10. register_ssh_key

• Fügen Sie einer bestimmten App einen SSH-Schlüssel hinzu
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • auth_ssh_private_key : Privater SSH-Schlüssel
  • auth_ssh_public_key : Öffentlicher SSH-Schlüssel
  • is_register_key_into_provider_service : Registrieren Sie den Schlüssel im Providerdienst

11. register_webhook

• Registrieren eines eingehenden Webhooks für eine bestimmte Anwendung
• Argumente:
  • app_slug : Kennung der Bitrise-App

Bauten

12. list_builds

• Listen Sie alle Builds einer bestimmten Bitrise-App oder alle verfügbaren Builds auf
• Argumente:
  • app_slug (optional): Kennung der Bitrise-App
  • sort_by (optional): Reihenfolge der Builds: created_at (Standard), running_first
  • branch (optional): Builds nach Zweig filtern
  • workflow (optional): Builds nach Workflow filtern
  • status (optional): Builds nach Status filtern (0: nicht abgeschlossen, 1: erfolgreich, 2: fehlgeschlagen, 3: abgebrochen, 4: in Bearbeitung)
  • next (optional): Slug des ersten Builds in der Antwort
  • limit (optional): Maximale Anzahl von Elementen pro Seite (Standard: 50)

13. trigger_bitrise_build

• Lösen Sie einen neuen Build/eine neue Pipeline für eine bestimmte Bitrise-App aus
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • branch (optional): Der zu erstellende Zweig (Standard: main)
  • workflow_id (optional): Der zu erstellende Workflow
  • commit_message (optional): Die Commit-Nachricht für den Build
  • commit_hash (optional): Der Commit-Hash für den Build

14. get_build

• Holen Sie sich einen bestimmten Build einer bestimmten App
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • build_slug : Kennung des Builds

15. abort_build

• Einen bestimmten Build abbrechen
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • build_slug : Kennung des Builds
  • reason (optional): Grund für den Abbruch des Builds

16. get_build_log

• Holen Sie sich das Build-Protokoll eines bestimmten Builds einer Bitrise-App
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • build_slug : Kennung des Bitrise-Builds

17. get_build_bitrise_yml

• Holen Sie sich die bitrise.yml eines Builds
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • build_slug : Kennung des Builds

18. list_build_workflows

• Auflisten der Workflows einer App
• Argumente:
  • app_slug : Kennung der Bitrise-App

Artefakte erstellen

19. list_artifacts

• Holen Sie sich eine Liste aller Build-Artefakte
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • build_slug : Kennung des Builds
  • next (optional): Slug des ersten Artefakts in der Antwort
  • limit (optional): Maximale Anzahl von Elementen pro Seite (Standard: 50)

20. get_artifact

• Abrufen eines bestimmten Build-Artefakts
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • build_slug : Kennung des Builds
  • artifact_slug : Kennung des Artefakts

21. delete_artifact

• Löschen eines Build-Artefakts
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • build_slug : Kennung des Builds
  • artifact_slug : Kennung des Artefakts

22. update_artifact

• Aktualisieren eines Build-Artefakts
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • build_slug : Kennung des Builds
  • artifact_slug : Kennung des Artefakts
  • is_public_page_enabled : Öffentliche Seite für das Artefakt aktivieren

Webhooks

23. list_outgoing_webhooks

• Listen Sie die ausgehenden Webhooks einer App auf
• Argumente:
  • app_slug : Kennung der Bitrise-App

24. delete_outgoing_webhook

• Löschen des ausgehenden Webhooks einer App
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • webhook_slug : Kennung des Webhooks

25. update_outgoing_webhook

• Aktualisieren eines ausgehenden Webhooks für eine App
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • webhook_slug : Kennung des Webhooks
  • events : Liste der Ereignisse zum Auslösen des Webhooks
  • url : URL des Webhooks
  • headers (optional): Mit dem Webhook zu sendende Header

26. create_outgoing_webhook

• Erstellen eines ausgehenden Webhooks für eine App
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • events : Liste der Ereignisse zum Auslösen des Webhooks
  • url : URL des Webhooks
  • headers (optional): Mit dem Webhook zu sendende Header

Cache-Elemente

27. list_cache_items

• Listen Sie die Schlüsselwert-Cache-Elemente auf, die zu einer App gehören
• Argumente:
  • app_slug : Kennung der Bitrise-App

28. delete_all_cache_items

• Löschen Sie alle Schlüsselwert-Cacheelemente, die zu einer App gehören
• Argumente:
  • app_slug : Kennung der Bitrise-App

29. delete_cache_item

• Löschen eines Schlüsselwert-Cacheelements
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • cache_item_id : Kennung des Cache-Elements

30. get_cache_item_download_url

• Holen Sie sich die Download-URL eines Schlüssel-Wert-Cache-Elements
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • cache_item_id : Kennung des Cache-Elements

Rohrleitungen

31. list_pipelines

• Alle Pipelines und Standalone-Builds einer App auflisten
• Argumente:
  • app_slug : Kennung der Bitrise-App

32. get_pipeline

• Holen Sie sich eine Pipeline einer bestimmten App
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • pipeline_id : Kennung der Pipeline

33. abort_pipeline

• Abbrechen einer Pipeline
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • pipeline_id : Kennung der Pipeline
  • reason (optional): Grund für den Abbruch der Pipeline

34. rebuild_pipeline

• Eine Pipeline neu erstellen
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • pipeline_id : Kennung der Pipeline

Gruppenrollen

35. list_group_roles

• Auflisten von Gruppenrollen für eine App
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • role_name : Name der Rolle

36. replace_group_roles

• Ersetzen von Gruppenrollen für eine App
• Argumente:
  • app_slug : Kennung der Bitrise-App
  • role_name : Name der Rolle
  • group_slugs : Liste der Gruppen-Slugs

Arbeitsbereiche

37. list_workspaces

• Auflisten der Arbeitsbereiche, auf die der Benutzer Zugriff hat

38. get_workspace

• Details zu einem Arbeitsbereich abrufen
• Argumente:
  • workspace_slug : Slug des Bitrise-Arbeitsbereichs

39. get_workspace_groups

• Abrufen der Gruppen in einem Arbeitsbereich
• Argumente:
  • workspace_slug : Slug des Bitrise-Arbeitsbereichs

40. create_workspace_group

• Erstellen einer Gruppe in einem Arbeitsbereich
• Argumente:
  • workspace_slug : Slug des Bitrise-Arbeitsbereichs
  • group_name : Name der Gruppe

41. get_workspace_members

• Holen Sie sich die Mitglieder in einem Arbeitsbereich
• Argumente:
  • workspace_slug : Slug des Bitrise-Arbeitsbereichs

42. invite_member_to_workspace

• Ein Mitglied zu einem Arbeitsbereich einladen
• Argumente:
  • workspace_slug : Slug des Bitrise-Arbeitsbereichs
  • email : E-Mail-Adresse des Benutzers

43. add_member_to_group

• Hinzufügen eines Mitglieds zu einer Gruppe
• Argumente:
  • group_slug : Slug der Gruppe
  • user_slug : Slug des Benutzers

Konto

44. me

• Informationen vom aktuell authentifizierten Benutzerkonto abrufen

Release-Verwaltung

MCP-Tools

45. create_connected_app

• Fügen Sie Bitrise eine neue mit Release Management verbundene App hinzu.
• Argumente:
  • platform : Die mobile Plattform für die verbundene App (iOS/Android).
  • store_app_id : Die App Store-Kennung für die verbundene App.
  • workspace_slug : Kennung des Bitrise-Arbeitsbereichs.
  • id : (Optional) Eine UUIDV4-Kennung für Ihre neue verbundene App.
  • manual_connection : (Optional) Zeigt eine manuelle Verbindung an.
  • project_id : (Optional) Gibt an, mit welchem Bitrise-Projekt eine Verknüpfung hergestellt werden soll.
  • store_app_name : (Optional) App-Name für manuelle Verbindungen.
  • store_credential_id : (Optional) Auswahl der auf Bitrise hinzugefügten Anmeldeinformationen.

46. list_connected_apps

• Listen Sie mit Release Management verbundene Apps auf, die für das authentifizierte Konto innerhalb eines Arbeitsbereichs verfügbar sind.
• Argumente:
  • workspace_slug : Kennung des Bitrise-Arbeitsbereichs.
  • items_per_page : (Optional) Maximale Anzahl verbundener Apps pro Seite.
  • page : (Optional) Zurückzugebende Seitenzahl.
  • platform : (Optional) Filter für eine bestimmte mobile Plattform.
  • project_id : (Optional) Filter für ein bestimmtes Bitrise-Projekt.
  • search : (Optional) Suchen Sie nach Bundle-ID, Paketname oder App-Titel.

47. get_connected_app

• Gibt eine mit Release Management verbundene App für das authentifizierte Konto zurück.
• Argumente:
  • id : Kennung der mit Release Management verbundenen App.

48. update_connected_app

• Aktualisiert eine verbundene App.
• Argumente:
  • connected_app_id : Die UUIDV4-Kennung für Ihre verbundene App.
  • store_app_id : Die Store-ID für Ihre App.
  • connect_to_store : (Optional) Überprüfen Sie die Gültigkeit im App Store oder bei Google Play.
  • store_credential_id : (Optional) Auswahl der auf Bitrise hinzugefügten Anmeldeinformationen.

49. list_installable_artifacts

• Listen Sie installierbare Release Management-Artefakte einer verbundenen App auf.
• Argumente:
  • connected_app_id : Kennung der mit Release Management verbundenen App.
  • after_date : (Optional) Beginn des Intervalls für die Erstellung/den Upload von Artefakten.
  • artifact_type : (Optional) Filter für einen bestimmten Artefakttyp.
  • before_date : (Optional) Ende des Intervalls für die Erstellung/den Upload von Artefakten.
  • branch : (Optional) Filter für den Bitrise CI-Zweig.
  • distribution_ready : (Optional) Filter für verteilungsbereite Artefakte.
  • items_per_page : (Optional) Maximale Anzahl von Artefakten pro Seite.
  • page : (Optional) Zurückzugebende Seitenzahl.
  • platform : (Optional) Filter für eine bestimmte mobile Plattform.
  • search : (Optional) Suche nach Version, Dateiname oder Buildnummer.
  • source : (Optional) Filter für die Quelle installierbarer Artefakte.
  • store_signed : (Optional) Filter für installierbare Store-Artefakte.
  • version : (Optional) Filtern Sie nach einer bestimmten Version.
  • workflow : (Optional) Filter für einen bestimmten Bitrise CI-Workflow.

50. generate_installable_artifact_upload_url

• Generiert eine signierte Upload-URL für ein installierbares Artefakt, das auf Bitrise hochgeladen werden soll.
• Argumente:
  • connected_app_id : Kennung der mit Release Management verbundenen App.
  • installable_artifact_id : Eine UUIDv4-Kennung für das installierbare Artefakt.
  • file_name : Der Name der installierbaren Artefaktdatei.
  • file_size_bytes : Die Bytegröße der installierbaren Artefaktdatei.
  • branch : (Optional) Name des CI-Zweigs.
  • with_public_page : (Optional) Öffentliche Installationsseite aktivieren.
  • workflow : (Optional) Name des CI-Workflows.

51. get_installable_artifact_upload_and_processing_status

• Ruft den Verarbeitungs- und Uploadstatus eines installierbaren Artefakts ab.
• Argumente:
  • connected_app_id : Kennung der mit Release Management verbundenen App.
  • installable_artifact_id : Die UUIDv4-Kennung für das installierbare Artefakt.

52. set_installable_artifact_public_install_page

• Ändert, ob für das installierbare Artefakt eine öffentliche Installationsseite verfügbar sein soll.
• Argumente:
  • connected_app_id : Kennung der mit Release Management verbundenen App.
  • installable_artifact_id : Die UUIDv4-Kennung für das installierbare Artefakt.
  • with_public_page : Boolesches Flag zum Aktivieren/Deaktivieren der öffentlichen Installationsseite.

53. list_build_distribution_versions

• Listet die für Tester verfügbaren Build-Distribution-Versionen auf.
• Argumente:
  • connected_app_id : Die UUIDV4-Kennung der verbundenen App.
  • items_per_page : (Optional) Maximale Anzahl von Versionen pro Seite.
  • page : (Optional) Zurückzugebende Seitenzahl.

54. list_build_distribution_version_test_builds

• Gibt eine Liste von Test-Builds für die angegebene Build-Distributionsversion zurück.
• Argumente:
  • connected_app_id : Die UUIDV4-Kennung der verbundenen App.
  • version : Die Version der Build-Distribution.
  • items_per_page : (Optional) Maximale Anzahl von Testbuilds pro Seite.
  • page : (Optional) Zurückzugebende Seitenzahl.

55. create_tester_group

• Erstellt eine Testergruppe für eine mit Release Management verbundene App.
• Argumente:
  • connected_app_id : Die UUIDV4-Kennung der verbundenen App.
  • name : Der Name für die neue Testergruppe.
  • auto_notify : (Optional) Gibt automatische Benachrichtigungen für die Gruppe an.

56. notify_tester_group

• Benachrichtigt eine Testergruppe über einen neuen Testbuild.
• Argumente:
  • connected_app_id : Die UUIDV4-Kennung der verbundenen App.
  • id : Die UUIDV4-Kennung der Testergruppe.
  • test_build_id : Die eindeutige Kennung des Testbuilds.

57. add_testers_to_tester_group

• Fügt Tester zu einer Testergruppe einer verbundenen App hinzu.
• Argumente:
  • connected_app_id : Die UUIDV4-Kennung der verbundenen App.
  • id : Die UUIDV4-Kennung der Testergruppe.
  • user_slugs : Die Liste der durch Slugs identifizierten Benutzer, die hinzugefügt werden sollen.

58. update_tester_group

• Aktualisiert die angegebenen Testergruppeneinstellungen.
• Argumente:
  • connected_app_id : Die UUIDV4-Kennung der verbundenen App.
  • id : Die UUIDV4-Kennung der Testergruppe.
  • auto_notify : (Optional) Einstellung für automatische E-Mail-Benachrichtigungen.
  • name : (Optional) Der neue Name für die Testergruppe.

59. list_tester_groups

• Gibt eine Liste von Testergruppen zurück, die mit einer bestimmten verbundenen App in Zusammenhang stehen.
• Argumente:
  • connected_app_id : Die UUIDV4-Kennung der verbundenen App.
  • items_per_page : (Optional) Maximale Anzahl von Testergruppen pro Seite.
  • page : (Optional) Zurückzugebende Seitenzahl.

60. get_tester_group

• Gibt die Details der ausgewählten Testergruppe zurück.
• Argumente:
  • connected_app_id : Die UUIDV4-Kennung der verbundenen App.
  • id : Die UUIDV4-Kennung der Testergruppe.

61. get_potential_testers

• Ruft eine Liste potenzieller Tester ab, die einer bestimmten Testergruppe hinzugefügt werden können.
• Argumente:
  • connected_app_id : Die UUIDV4-Kennung der verbundenen App.
  • id : Die UUIDV4-Kennung der Testergruppe.
  • items_per_page : (Optional) Maximale Anzahl potenzieller Tester pro Seite.
  • page : (Optional) Zurückzugebende Seitenzahl.
  • search : (Optional) Suchen Sie nach Testern per E-Mail oder Benutzername.

API-Gruppen

Der Bitrise MCP-Server organisiert Tools in API-Gruppen, die über Befehlszeilenargumente aktiviert oder deaktiviert werden können. Die folgende Tabelle zeigt, zu welchen API-Gruppen jedes Tool gehört:

Standardmäßig sind alle API-Gruppen aktiviert. Sie können die zu aktivierenden Gruppen mit dem Befehlszeilenargument --enabled-api-groups und einer durch Kommas getrennten Liste von Gruppennamen angeben.