GitHub - bitrise-io/bitrise-mcp: MCP Server for the Bitrise API, enabling app management, build operations, artifact management and more. (original) (raw)

Bitrise MCP Server

MCP Server for the Bitrise API, enabling app management, build operations, artifact management and more.

Features

• Comprehensive API Access: Access to Bitrise APIs including apps, builds, artifacts, and more.
• Authentication Support: Secure API token-based access to Bitrise resources.
• Detailed Documentation: Well-documented tools with parameter descriptions.

Setup

Environment Setup

• Python 3.12.6 required (you can use pyenv).
• Use uv for dependency management.

Example setting up the environment

Please read the official documentation for uv and pylint for more options.

Install pyenv and python 3.12.6

curl -fsSL https://pyenv.run | bash pyenv install 3.12.6

Install uv

curl -LsSf https://astral.sh/uv/install.sh | sh

Bitrise API Token

Create a Bitrise API Token:

• Go to your Bitrise Account Settings/Security.
• Navigate to the "Personal access tokens" section.
• Copy the generated token.

Use with Claude Desktop

This guide uses Claude Desktop as the MCP client, but you can use any other MCP-compatible client and adapt the following config options to your preferred client.

Open Claude settings, then navigate to the Developer tab.

Click Edit config. This creates a config file called claude_desktop_config.json. Open this file with your preferred editor and add the Bitrise MCP server:

{ "mcpServers": { "bitrise": { "command": "uvx", "env": { "BITRISE_TOKEN": "" }, "args": [ "--from", "git+https://github.com/bitrise-io/bitrise-mcp@v1.1.0", "bitrise-mcp" ] } } }

Save the config file and restart Claude Desktop. If everything is set up correctly, you should see a hammer icon next to the message composer.

Use with VS Code

Follow the official guide to enable Agent mode in Copilot Chat.

Then, open VSCode's settings.json (either the workspace level or the user level settings), and add the Bitrise MCP server configuration under the mcp.servers key, and the workspace token input under the mcp.inputs key:

{ "mcp": { "inputs": [ { "id": "bitrise-workspace-token", "type": "promptString", "description": "Bitrise workspace token", "password": true } ], "servers": { "bitrise": { "command": "uvx", "args": [ "--from", "git+https://github.com/bitrise-io/bitrise-mcp@v1.0.1", "bitrise-mcp" ], "type": "stdio", "env": { "BITRISE_TOKEN": "${input:bitrise-workspace-token}" } }, } } }

Save the configuration. VS Code will automatically recognize the change and load the tools into Copilot Chat.

Advanced configuration

You can limit the number of tools exposed to the MCP client. This is useful if you want to optimize token usage or your MCP client has a limit on the number of tools.

Tools are grouped by their "API group", and you can pass the groups you want to expose as tools. Possible values: apps, builds, workspaces, webhooks, build-artifacts, group-roles, cache-items, pipelines, account, read-only, release-management.

We recommend using the release-management API group separately to avoid any confusion with the apps API group.

Example configuration:

{ "mcpServers": { "bitrise": { "command": "uvx", "env": { "BITRISE_TOKEN": "" }, "args": [ "--from", "git+https://github.com/bitrise-io/bitrise-mcp@v1.1.0", "bitrise-mcp", "--enabled-api-groups", "cache-items,pipelines" ] }, } }

Tools

Apps

1. list_apps
   • List all the apps available for the authenticated account
   • Arguments:
     * sort_by (optional): Order of the apps: last_build_at (default) or created_at
     * next (optional): Slug of the first app in the response
     * limit (optional): Max number of elements per page (default: 50)
2. register_app
   • Add a new app to Bitrise
   • Arguments:
     * repo_url: Repository URL
     * is_public: Whether the app's builds visibility is "public"
     * organization_slug: The organization (aka workspace) the app to add to
     * project_type (optional): Type of project (ios, android, etc.)
     * provider (optional): github
3. finish_bitrise_app
   • Finish the setup of a Bitrise app
   • Arguments:
     * app_slug: The slug of the Bitrise app to finish setup for
     * project_type (optional): The type of project (e.g., android, ios, flutter, etc.)
     * stack_id (optional): The stack ID to use for the app
     * mode (optional): The mode of setup
     * config (optional): The configuration to use for the app
4. get_app
   • Get the details of a specific app
   • Arguments:
     * app_slug: Identifier of the Bitrise app
5. delete_app
   • Delete an app from Bitrise
   • Arguments:
     * app_slug: Identifier of the Bitrise app
6. update_app
   • Update an app
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * is_public: Whether the app's builds visibility is "public"
     * project_type: Type of project
     * provider: Repository provider
     * repo_url: Repository URL
7. get_bitrise_yml
   • Get the current Bitrise YML config file of a specified Bitrise app
   • Arguments:
     * app_slug: Identifier of the Bitrise app
8. update_bitrise_yml
   • Update the Bitrise YML config file of a specified Bitrise app
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * bitrise_yml_as_json: The new Bitrise YML config file content
9. list_branches
   • List the branches with existing builds of an app's repository
   • Arguments:
     * app_slug: Identifier of the Bitrise app
10. register_ssh_key

• Add an SSH-key to a specific app
• Arguments:
  * app_slug: Identifier of the Bitrise app
  * auth_ssh_private_key: Private SSH key
  * auth_ssh_public_key: Public SSH key
  * is_register_key_into_provider_service: Register the key in the provider service

1. register_webhook

• Register an incoming webhook for a specific application
• Arguments:
  * app_slug: Identifier of the Bitrise app

Builds

1. list_builds
   • List all the builds of a specified Bitrise app or all accessible builds
   • Arguments:
     * app_slug (optional): Identifier of the Bitrise app
     * sort_by (optional): Order of builds: created_at (default), running_first
     * branch (optional): Filter builds by branch
     * workflow (optional): Filter builds by workflow
     * status (optional): Filter builds by status (0: not finished, 1: successful, 2: failed, 3: aborted, 4: in-progress)
     * next (optional): Slug of the first build in the response
     * limit (optional): Max number of elements per page (default: 50)
2. trigger_bitrise_build
   • Trigger a new build/pipeline for a specified Bitrise app
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * branch (optional): The branch to build (default: main)
     * workflow_id (optional): The workflow to build
     * commit_message (optional): The commit message for the build
     * commit_hash (optional): The commit hash for the build
3. get_build
   • Get a specific build of a given app
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * build_slug: Identifier of the build
4. abort_build
   • Abort a specific build
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * build_slug: Identifier of the build
     * reason (optional): Reason for aborting the build
5. get_build_log
   • Get the build log of a specified build of a Bitrise app
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * build_slug: Identifier of the Bitrise build
6. get_build_bitrise_yml
   • Get the bitrise.yml of a build
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * build_slug: Identifier of the build
7. list_build_workflows
   • List the workflows of an app
   • Arguments:
     * app_slug: Identifier of the Bitrise app

Build Artifacts

1. list_artifacts
   • Get a list of all build artifacts
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * build_slug: Identifier of the build
     * next (optional): Slug of the first artifact in the response
     * limit (optional): Max number of elements per page (default: 50)
2. get_artifact
   • Get a specific build artifact
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * build_slug: Identifier of the build
     * artifact_slug: Identifier of the artifact
3. delete_artifact
   • Delete a build artifact
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * build_slug: Identifier of the build
     * artifact_slug: Identifier of the artifact
4. update_artifact
   • Update a build artifact
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * build_slug: Identifier of the build
     * artifact_slug: Identifier of the artifact
     * is_public_page_enabled: Enable public page for the artifact

Webhooks

1. list_outgoing_webhooks
   • List the outgoing webhooks of an app
   • Arguments:
     * app_slug: Identifier of the Bitrise app
2. delete_outgoing_webhook
   • Delete the outgoing webhook of an app
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * webhook_slug: Identifier of the webhook
3. update_outgoing_webhook
   • Update an outgoing webhook for an app
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * webhook_slug: Identifier of the webhook
     * events: List of events to trigger the webhook
     * url: URL of the webhook
     * headers (optional): Headers to be sent with the webhook
4. create_outgoing_webhook
   • Create an outgoing webhook for an app
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * events: List of events to trigger the webhook
     * url: URL of the webhook
     * headers (optional): Headers to be sent with the webhook

Cache Items

1. list_cache_items
   • List the key-value cache items belonging to an app
   • Arguments:
     * app_slug: Identifier of the Bitrise app
2. delete_all_cache_items
   • Delete all key-value cache items belonging to an app
   • Arguments:
     * app_slug: Identifier of the Bitrise app
3. delete_cache_item
   • Delete a key-value cache item
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * cache_item_id: Identifier of the cache item
4. get_cache_item_download_url
   • Get the download URL of a key-value cache item
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * cache_item_id: Identifier of the cache item

Pipelines

1. list_pipelines
   • List all pipelines and standalone builds of an app
   • Arguments:
     * app_slug: Identifier of the Bitrise app
2. get_pipeline
   • Get a pipeline of a given app
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * pipeline_id: Identifier of the pipeline
3. abort_pipeline
   • Abort a pipeline
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * pipeline_id: Identifier of the pipeline
     * reason (optional): Reason for aborting the pipeline
4. rebuild_pipeline
   • Rebuild a pipeline
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * pipeline_id: Identifier of the pipeline

Group Roles

1. list_group_roles
   • List group roles for an app
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * role_name: Name of the role
2. replace_group_roles
   • Replace group roles for an app
   • Arguments:
     * app_slug: Identifier of the Bitrise app
     * role_name: Name of the role
     * group_slugs: List of group slugs

Workspaces

1. list_workspaces
   • List the workspaces the user has access to
2. get_workspace
   • Get details for one workspace
   • Arguments:
     * workspace_slug: Slug of the Bitrise workspace
3. get_workspace_groups
   • Get the groups in a workspace
   • Arguments:
     * workspace_slug: Slug of the Bitrise workspace
4. create_workspace_group
   • Create a group in a workspace
   • Arguments:
     * workspace_slug: Slug of the Bitrise workspace
     * group_name: Name of the group
5. get_workspace_members
   • Get the members in a workspace
   • Arguments:
     * workspace_slug: Slug of the Bitrise workspace
6. invite_member_to_workspace
   • Invite a member to a workspace
   • Arguments:
     * workspace_slug: Slug of the Bitrise workspace
     * email: Email address of the user
7. add_member_to_group
   • Add a member to a group
   • Arguments:
     * group_slug: Slug of the group
     * user_slug: Slug of the user

Account

1. me
   • Get info from the currently authenticated user account

Release Management

MCP Tools

1. create_connected_app

• Add a new Release Management connected app to Bitrise.
• Arguments:
  • platform: The mobile platform for the connected app (ios/android).
  • store_app_id: The app store identifier for the connected app.
  • workspace_slug: Identifier of the Bitrise workspace.
  • id: (Optional) An uuidV4 identifier for your new connected app.
  • manual_connection: (Optional) Indicates a manual connection.
  • project_id: (Optional) Specifies which Bitrise Project to associate with.
  • store_app_name: (Optional) App name for manual connections.
  • store_credential_id: (Optional) Selection of credentials added on Bitrise.

1. list_connected_apps

• List Release Management connected apps available for the authenticated account within a workspace.
• Arguments:
  • workspace_slug: Identifier of the Bitrise workspace.
  • items_per_page: (Optional) Maximum number of connected apps per page.
  • page: (Optional) Page number to return.
  • platform: (Optional) Filter for a specific mobile platform.
  • project_id: (Optional) Filter for a specific Bitrise Project.
  • search: (Optional) Search by bundle ID, package name, or app title.

1. get_connected_app

• Gives back a Release Management connected app for the authenticated account.
• Arguments:
  • id: Identifier of the Release Management connected app.

1. update_connected_app

• Updates a connected app.
• Arguments:
  • connected_app_id: The uuidV4 identifier for your connected app.
  • store_app_id: The store identifier for your app.
  • connect_to_store: (Optional) Check validity against the App Store or Google Play.
  • store_credential_id: (Optional) Selection of credentials added on Bitrise.

1. list_installable_artifacts

• List Release Management installable artifacts of a connected app.
• Arguments:
  • connected_app_id: Identifier of the Release Management connected app.
  • after_date: (Optional) Start of the interval for artifact creation/upload.
  • artifact_type: (Optional) Filter for a specific artifact type.
  • before_date: (Optional) End of the interval for artifact creation/upload.
  • branch: (Optional) Filter for the Bitrise CI branch.
  • distribution_ready: (Optional) Filter for distribution ready artifacts.
  • items_per_page: (Optional) Maximum number of artifacts per page.
  • page: (Optional) Page number to return.
  • platform: (Optional) Filter for a specific mobile platform.
  • search: (Optional) Search by version, filename or build number.
  • source: (Optional) Filter for the source of installable artifacts.
  • store_signed: (Optional) Filter for store ready installable artifacts.
  • version: (Optional) Filter for a specific version.
  • workflow: (Optional) Filter for a specific Bitrise CI workflow.

1. generate_installable_artifact_upload_url

• Generates a signed upload URL for an installable artifact to be uploaded to Bitrise.
• Arguments:
  • connected_app_id: Identifier of the Release Management connected app.
  • installable_artifact_id: An uuidv4 identifier for the installable artifact.
  • file_name: The name of the installable artifact file.
  • file_size_bytes: The byte size of the installable artifact file.
  • branch: (Optional) Name of the CI branch.
  • with_public_page: (Optional) Enable public install page.
  • workflow: (Optional) Name of the CI workflow.

1. get_installable_artifact_upload_and_processing_status

• Gets the processing and upload status of an installable artifact.
• Arguments:
  • connected_app_id: Identifier of the Release Management connected app.
  • installable_artifact_id: The uuidv4 identifier for the installable artifact.

1. set_installable_artifact_public_install_page

• Changes whether public install page should be available for the installable artifact.
• Arguments:
  • connected_app_id: Identifier of the Release Management connected app.
  • installable_artifact_id: The uuidv4 identifier for the installable artifact.
  • with_public_page: Boolean flag for enabling/disabling public install page.

1. list_build_distribution_versions

• Lists Build Distribution versions available for testers.
• Arguments:
  • connected_app_id: The uuidV4 identifier of the connected app.
  • items_per_page: (Optional) Maximum number of versions per page.
  • page: (Optional) Page number to return.

1. list_build_distribution_version_test_builds

• Gives back a list of test builds for the given build distribution version.
• Arguments:
  • connected_app_id: The uuidV4 identifier of the connected app.
  • version: The version of the build distribution.
  • items_per_page: (Optional) Maximum number of test builds per page.
  • page: (Optional) Page number to return.

1. create_tester_group

• Creates a tester group for a Release Management connected app.
• Arguments:
  • connected_app_id: The uuidV4 identifier of the connected app.
  • name: The name for the new tester group.
  • auto_notify: (Optional) Indicates automatic notifications for the group.

1. notify_tester_group

• Notifies a tester group about a new test build.
• Arguments:
  • connected_app_id: The uuidV4 identifier of the connected app.
  • id: The uuidV4 identifier of the tester group.
  • test_build_id: The unique identifier of the test build.

1. add_testers_to_tester_group

• Adds testers to a tester group of a connected app.
• Arguments:
  • connected_app_id: The uuidV4 identifier of the connected app.
  • id: The uuidV4 identifier of the tester group.
  • user_slugs: The list of users identified by slugs to be added.

1. update_tester_group

• Updates the given tester group settings.
• Arguments:
  • connected_app_id: The uuidV4 identifier of the connected app.
  • id: The uuidV4 identifier of the tester group.
  • auto_notify: (Optional) Setting for automatic email notifications.
  • name: (Optional) The new name for the tester group.

1. list_tester_groups

• Gives back a list of tester groups related to a specific connected app.
• Arguments:
  • connected_app_id: The uuidV4 identifier of the connected app.
  • items_per_page: (Optional) Maximum number of tester groups per page.
  • page: (Optional) Page number to return.

1. get_tester_group

• Gives back the details of the selected tester group.
• Arguments:
  • connected_app_id: The uuidV4 identifier of the connected app.
  • id: The uuidV4 identifier of the tester group.

1. get_potential_testers

• Gets a list of potential testers who can be added to a specific tester group.
• Arguments:
  • connected_app_id: The uuidV4 identifier of the connected app.
  • id: The uuidV4 identifier of the tester group.
  • items_per_page: (Optional) Maximum number of potential testers per page.
  • page: (Optional) Page number to return.
  • search: (Optional) Search for testers by email or username.

API Groups

The Bitrise MCP server organizes tools into API groups that can be enabled or disabled via command-line arguments. The table below shows which API groups each tool belongs to:

By default, all API groups are enabled. You can specify which groups to enable using the --enabled-api-groups command-line argument with a comma-separated list of group names.