Bitrise MCP Server

Bitrise MCP 服务器

Bitrise API 的 MCP 服务器，支持应用程序管理、构建操作、工件管理等。

特征

• 全面的 API 访问：访问 Bitrise API，包括应用程序、构建、工件等。
• 身份验证支持：基于安全 API 令牌访问 Bitrise 资源。
• 详细文档：具有参数描述的详细文档工具。

设置

环境设置

• 需要 Python 3.12.6（您可以使用pyenv ）。
• 使用uv进行依赖管理。

环境设置示例

请阅读 uv 和 pylint 的官方文档以了解更多选项。

Bitrise API 令牌

创建 Bitrise API 令牌：

• 转到您的Bitrise 帐户设置/安全。
• 导航到“个人访问令牌”部分。
• 复制生成的令牌。

与Claude Desktop一起使用

本指南使用 Claude Desktop 作为 MCP 客户端，但您可以使用任何其他与 MCP 兼容的客户端，并将以下配置选项调整到您喜欢的客户端。

打开 Claude 设置，然后导航到开发人员选项卡。

点击*“编辑配置”* 。这会创建一个名为claude_desktop_config.json的配置文件。用你喜欢的编辑器打开此文件，并添加 Bitrise MCP 服务器：

保存配置文件并重启 Claude Desktop。如果一切设置正确，你应该会在消息编辑器旁边看到一个锤子图标。

与VS Code一起使用

按照官方指南在 Copilot Chat 中启用代理模式。

然后，打开 VSCode 的settings.json （工作区级别或用户级别设置），在mcp.servers键下添加 Bitrise MCP 服务器配置，在mcp.inputs键下添加工作区令牌输入：

保存配置。VS Code 将自动识别更改并将工具加载到 Copilot Chat 中。

高级配置

您可以限制向 MCP 客户端公开的工具数量。如果您想要优化令牌使用率，或者您的 MCP 客户端对工具数量有限制，此功能非常有用。

工具按其“API 组”分组，您可以传递要公开为工具的组。可能的值： apps, builds, workspaces, webhooks, build-artifacts, group-roles, cache-items, pipelines, account, read-only, release-management 。

我们建议单独使用release-management API 组，以避免与apps API 组混淆。

示例配置：

工具

应用程序

1. list_apps
   • 列出已验证帐户可用的所有应用
   • 参数：
     • sort_by （可选）：应用程序的顺序：last_build_at（默认）或created_at
     • next （可选）：响应中第一个应用程序的 Slug
     • limit （可选）：每页的最大元素数（默认值：50）
2. register_app
   • 向 Bitrise 添加新应用
   • 参数：
     • repo_url ：存储库 URL
     • is_public ：应用程序的构建可见性是否为“公开”
     • organization_slug ：应用程序要添加到的组织（又名工作区）
     • project_type （可选）：项目类型（ios、android 等）
     • provider （可选）：github
3. finish_bitrise_app
   • 完成 Bitrise 应用程序的设置
   • 参数：
     • app_slug ：Bitrise 应用程序的 slug，用于完成设置
     • project_type （可选）：项目类型（例如，android、ios、flutter 等）
     • stack_id （可选）：应用程序使用的堆栈 ID
     • mode （可选）：设置模式
     • config （可选）：应用程序使用的配置
4. get_app
   • 获取特定应用的详细信息
   • 参数：
     • app_slug ：Bitrise 应用程序的标识符
5. delete_app
   • 从 Bitrise 中删除应用程序
   • 参数：
     • app_slug ：Bitrise 应用程序的标识符
6. update_app
   • 更新应用程序
   • 参数：
     • app_slug ：Bitrise 应用程序的标识符
     • is_public ：应用程序的构建可见性是否为“公开”
     • project_type ：项目类型
     • provider ：存储库提供者
     • repo_url ：存储库 URL
7. get_bitrise_yml
   • 获取指定 Bitrise 应用的当前 Bitrise YML 配置文件
   • 参数：
     • app_slug ：Bitrise 应用程序的标识符
8. update_bitrise_yml
   • 更新指定 Bitrise 应用的 Bitrise YML 配置文件
   • 参数：
     • app_slug ：Bitrise 应用程序的标识符
     • bitrise_yml_as_json ：新的 Bitrise YML 配置文件内容
9. list_branches
   • 列出应用程序存储库中现有版本的分支
   • 参数：
     • app_slug ：Bitrise 应用程序的标识符
10. register_ssh_key

• 将 SSH 密钥添加到特定应用
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • auth_ssh_private_key ：私有 SSH 密钥
  • auth_ssh_public_key ：公共 SSH 密钥
  • is_register_key_into_provider_service ：在提供商服务中注册密钥

11. register_webhook

• 为特定应用程序注册传入 webhook
• 参数：
  • app_slug ：Bitrise 应用程序的标识符

构建

12. list_builds

• 列出指定 Bitrise 应用程序的所有构建或所有可访问的构建
• 参数：
  • app_slug （可选）：Bitrise 应用程序的标识符
  • sort_by （可选）：构建顺序：created_at（默认）、running_first
  • branch （可选）：按分支过滤构建
  • workflow （可选）：按工作流程过滤构建
  • status （可选）：按状态过滤构建（0：未完成，1：成功，2：失败，3：中止，4：进行中）
  • next （可选）：响应中第一个构建的 Slug
  • limit （可选）：每页的最大元素数（默认值：50）

13. trigger_bitrise_build

• 为指定的 Bitrise 应用触发新的构建/管道
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • branch （可选）：要构建的分支（默认值：主分支）
  • workflow_id （可选）：要构建的工作流程
  • commit_message （可选）：构建的提交消息
  • commit_hash （可选）：构建的提交哈希

14. get_build

• 获取给定应用程序的特定版本
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • build_slug ：构建的标识符

15. abort_build

• 中止特定构建
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • build_slug ：构建的标识符
  • reason （可选）：中止构建的原因

16. get_build_log

• 获取 Bitrise 应用程序指定构建的构建日志
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • build_slug ：Bitrise 构建的标识符

17. get_build_bitrise_yml

• 获取构建的 bitrise.yml
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • build_slug ：构建的标识符

18. list_build_workflows

• 列出应用程序的工作流程
• 参数：
  • app_slug ：Bitrise 应用程序的标识符

构建工件

19. list_artifacts

• 获取所有构建工件的列表
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • build_slug ：构建的标识符
  • next （可选）：响应中第一个工件的 Slug
  • limit （可选）：每页的最大元素数（默认值：50）

20. get_artifact

• 获取特定的构建工件
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • build_slug ：构建的标识符
  • artifact_slug ：工件的标识符

21. delete_artifact

• 删除构建工件
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • build_slug ：构建的标识符
  • artifact_slug ：工件的标识符

22. update_artifact

• 更新构建工件
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • build_slug ：构建的标识符
  • artifact_slug ：工件的标识符
  • is_public_page_enabled ：为工件启用公共页面

Webhook

23. list_outgoing_webhooks

• 列出应用程序的传出 webhook
• 参数：
  • app_slug ：Bitrise 应用程序的标识符

24. delete_outgoing_webhook

• 删除应用程序的传出 webhook
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • webhook_slug ：webhook 的标识符

25. update_outgoing_webhook

• 更新应用的传出 webhook
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • webhook_slug ：webhook 的标识符
  • events ：触发 webhook 的事件列表
  • url ：webhook 的 URL
  • headers （可选）：通过 webhook 发送的 headers

26. create_outgoing_webhook

• 为应用创建传出 Webhook
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • events ：触发 webhook 的事件列表
  • url ：webhook 的 URL
  • headers （可选）：通过 webhook 发送的 headers

缓存项

27. list_cache_items

• 列出属于应用程序的键值缓存项
• 参数：
  • app_slug ：Bitrise 应用程序的标识符

28. delete_all_cache_items

• 删除属于某个应用的所有键值缓存项
• 参数：
  • app_slug ：Bitrise 应用程序的标识符

29. delete_cache_item

• 删除键值缓存项
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • cache_item_id ：缓存项的标识符

30. get_cache_item_download_url

• 获取键值缓存项的下载 URL
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • cache_item_id ：缓存项的标识符

管道

31. list_pipelines

• 列出应用程序的所有管道和独立构建
• 参数：
  • app_slug ：Bitrise 应用程序的标识符

32. get_pipeline

• 获取给定应用程序的管道
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • pipeline_id ：管道的标识符

33. abort_pipeline

• 中止管道
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • pipeline_id ：管道的标识符
  • reason （可选）：中止管道的原因

34. rebuild_pipeline

• 重建管道
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • pipeline_id ：管道的标识符

群组角色

35. list_group_roles

• 列出应用程序的组角色
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • role_name ：角色的名称

36. replace_group_roles

• 替换应用程序的组角色
• 参数：
  • app_slug ：Bitrise 应用程序的标识符
  • role_name ：角色的名称
  • group_slugs ：组 slug 列表

工作区

37. list_workspaces

• 列出用户有权访问的工作区

38. get_workspace

• 获取一个工作区的详细信息
• 参数：
  • workspace_slug ：Bitrise 工作区的 Slug

39. get_workspace_groups

• 获取工作区中的组
• 参数：
  • workspace_slug ：Bitrise 工作区的 Slug

40. create_workspace_group

• 在工作区中创建组
• 参数：
  • workspace_slug ：Bitrise 工作区的 Slug
  • group_name ：组的名称

41. get_workspace_members

• 获取工作区中的成员
• 参数：
  • workspace_slug ：Bitrise 工作区的 Slug

42. invite_member_to_workspace

• 邀请成员加入工作区
• 参数：
  • workspace_slug ：Bitrise 工作区的 Slug
  • email ：用户的电子邮件地址

43. add_member_to_group

• 向组添加成员
• 参数：
  • group_slug ：群组成员
  • user_slug ：用户的 Slug

帐户

44. me

• 从当前已验证的用户帐户获取信息

发布管理

MCP 工具

45. create_connected_app

• 向 Bitrise 添加新的发布管理连接应用程序。
• 参数：
  • platform ：连接的应用程序的移动平台（ios / android）。
  • store_app_id ：连接的应用程序的应用商店标识符。
  • workspace_slug ：Bitrise 工作区的标识符。
  • id ：（可选）新连接的应用程序的 uuidV4 标识符。
  • manual_connection ：（可选）表示手动连接。
  • project_id ：（可选）指定要关联的 Bitrise 项目。
  • store_app_name ：（可选）手动连接的应用程序名称。
  • store_credential_id ：（可选）在 Bitrise 上添加的凭证选择。

46. list_connected_apps

• 列出工作区内经过身份验证的帐户可用的发布管理连接应用程序。
• 参数：
  • workspace_slug ：Bitrise 工作区的标识符。
  • items_per_page ：（可选）每页连接的应用程序的最大数量。
  • page ：（可选）要返回的页码。
  • platform ：（可选）针对特定移动平台的过滤器。
  • project_id ：（可选）过滤特定的 Bitrise 项目。
  • search ：（可选）按软件包 ID、软件包名称或应用程序标题搜索。

47. get_connected_app

• 返回已验证帐户的发布管理连接应用程序。
• 参数：
  • id ：发布管理连接的应用程序的标识符。

48. update_connected_app

• 更新连接的应用程序。
• 参数：
  • connected_app_id ：已连接应用程序的 uuidV4 标识符。
  • store_app_id ：您的应用的商店标识符。
  • connect_to_store ：（可选）根据 App Store 或 Google Play 检查有效性。
  • store_credential_id ：（可选）在 Bitrise 上添加的凭证选择。

49. list_installable_artifacts

• 列出已连接应用程序的发布管理可安装工件。
• 参数：
  • connected_app_id ：发布管理连接的应用程序的标识符。
  • after_date ：（可选）工件创建/上传间隔的开始。
  • artifact_type ：（可选）过滤特定的工件类型。
  • before_date ：（可选）工件创建/上传间隔的结束时间。
  • branch ：（可选）Bitrise CI 分支的过滤器。
  • distribution_ready ：（可选）过滤已准备好分发的工件。
  • items_per_page ：（可选）每页的最大工件数量。
  • page ：（可选）要返回的页码。
  • platform ：（可选）针对特定移动平台的过滤器。
  • search ：（可选）按版本、文件名或版本号搜索。
  • source ：（可选）过滤可安装工件的来源。
  • store_signed ：（可选）过滤可供商店安装的工件。
  • version ：（可选）过滤特定版本。
  • workflow ：（可选）过滤特定的 Bitrise CI 工作流程。

50. generate_installable_artifact_upload_url

• 为要上传到 Bitrise 的可安装工件生成签名的上传 URL。
• 参数：
  • connected_app_id ：发布管理连接的应用程序的标识符。
  • installable_artifact_id ：可安装工件的 uuidv4 标识符。
  • file_name ：可安装工件文件的名称。
  • file_size_bytes ：可安装工件文件的字节大小。
  • branch ：（可选）CI 分支的名称。
  • with_public_page ：（可选）启用公共安装页面。
  • workflow ：（可选）CI 工作流程的名称。

51. get_installable_artifact_upload_and_processing_status

• 获取可安装工件的处理和上传状态。
• 参数：
  • connected_app_id ：发布管理连接的应用程序的标识符。
  • installable_artifact_id ：可安装工件的 uuidv4 标识符。

52. set_installable_artifact_public_install_page

• 更改可安装工件是否可用公共安装页面。
• 参数：
  • connected_app_id ：发布管理连接的应用程序的标识符。
  • installable_artifact_id ：可安装工件的 uuidv4 标识符。
  • with_public_page ：用于启用/禁用公共安装页面的布尔标志。

53. list_build_distribution_versions

• 列出可供测试人员使用的 Build Distribution 版本。
• 参数：
  • connected_app_id ：连接的应用程序的 uuidV4 标识符。
  • items_per_page ：（可选）每页的最大版本数。
  • page ：（可选）要返回的页码。

54. list_build_distribution_version_test_builds

• 返回给定构建分发版本的测试构建列表。
• 参数：
  • connected_app_id ：连接的应用程序的 uuidV4 标识符。
  • version ：构建分发的版本。
  • items_per_page ：（可选）每页的最大测试构建数。
  • page ：（可选）要返回的页码。

55. create_tester_group

• 为 Release Management 连接的应用程序创建测试人员组。
• 参数：
  • connected_app_id ：连接的应用程序的 uuidV4 标识符。
  • name ：新测试人员组的名称。
  • auto_notify ：（可选）表示组的自动通知。

56. notify_tester_group

• 通知测试人员组有关新的测试版本。
• 参数：
  • connected_app_id ：连接的应用程序的 uuidV4 标识符。
  • id ：测试人员组的 uuidV4 标识符。
  • test_build_id ：测试构建的唯一标识符。

57. add_testers_to_tester_group

• 将测试人员添加到连接的应用程序的测试人员组。
• 参数：
  • connected_app_id ：连接的应用程序的 uuidV4 标识符。
  • id ：测试人员组的 uuidV4 标识符。
  • user_slugs ：要添加的由 slug 标识的用户列表。

58. update_tester_group

• 更新给定的测试人员组设置。
• 参数：
  • connected_app_id ：连接的应用程序的 uuidV4 标识符。
  • id ：测试人员组的 uuidV4 标识符。
  • auto_notify ：（可选）设置自动电子邮件通知。
  • name ：（可选）测试人员组的新名称。

59. list_tester_groups

• 返回与特定连接的应用程序相关的测试人员组列表。
• 参数：
  • connected_app_id ：连接的应用程序的 uuidV4 标识符。
  • items_per_page ：（可选）每页的最大测试人员组数。
  • page ：（可选）要返回的页码。

60. get_tester_group

• 返回选定测试人员组的详细信息。
• 参数：
  • connected_app_id ：连接的应用程序的 uuidV4 标识符。
  • id ：测试人员组的 uuidV4 标识符。

61. get_potential_testers

• 获取可添加到特定测试人员组的潜在测试人员列表。
• 参数：
  • connected_app_id ：连接的应用程序的 uuidV4 标识符。
  • id ：测试人员组的 uuidV4 标识符。
  • items_per_page ：（可选）每页最大潜在测试人员数量。
  • page ：（可选）要返回的页码。
  • search ：（可选）通过电子邮件或用户名搜索测试人员。

API 组

Bitrise MCP 服务器将工具组织成 API 组，可以通过命令行参数启用或禁用这些 API 组。下表显示了每个工具所属的 API 组：

默认情况下，所有 API 组均已启用。您可以使用--enabled-api-groups命令行参数指定要启用的组，该参数包含以逗号分隔的组名列表。