使用说明
项目简介
Bitrise MCP Server 是一个专为 Bitrise API 设计的 MCP 服务器实现。它允许用户通过兼容 MCP 协议的 LLM 客户端(如 Claude Desktop)以标准化的方式访问和操作 Bitrise 的各项功能,例如应用管理、构建操作、构建产物管理等。
主要功能点
- 全面的 Bitrise API 访问: 提供了对 Bitrise API 的广泛访问,包括应用、构建、构建产物等核心资源的管理能力。
- 工具化操作: 将 Bitrise API 的功能封装成易于理解和使用的工具,例如列出应用、触发构建、查看构建日志等,方便 LLM 客户端调用。
- 安全认证: 通过 Bitrise API Token 进行安全认证,确保只有授权用户才能访问其 Bitrise 资源。
- 详细的工具文档: 每个工具都附带清晰的参数描述,方便用户理解和使用。
- 灵活的 API Group 控制: 允许用户通过配置启用或禁用特定的 API 功能组,以优化工具列表或满足特定需求。
安装步骤
-
环境准备:
- 确保已安装 Python 3.12.6。推荐使用 'pyenv' 进行 Python 版本管理。
- 安装 'uv' 包管理器,用于依赖管理和项目运行。
# 安装 pyenv 和 Python 3.12.6 (如果尚未安装) curl -fsSL https://pyenv.run | bash pyenv install 3.12.6 # 安装 uv (如果尚未安装) curl -LsSf https://astral.sh/uv/install.sh | sh -
获取 Bitrise API Token:
- 访问 Bitrise Account Settings/Security。
- 在 "Personal access tokens" 部分创建并复制您的 API Token。
服务器配置
要将 Bitrise MCP Server 集成到 MCP 客户端(例如 Claude Desktop),您需要配置客户端的 MCP 服务器设置。以下是 Claude Desktop 的配置示例,其他 MCP 客户端的配置方法类似,请参考各自客户端的文档进行调整。
-
打开 Claude Desktop 设置:
- 进入 Claude Desktop 的设置界面。
- 导航到 "Developer" 选项卡。
-
编辑配置:
- 点击 "Edit config" 按钮。这将创建一个名为 'claude_desktop_config.json' 的配置文件。
-
添加 Bitrise MCP Server 配置:
- 使用文本编辑器打开 'claude_desktop_config.json' 文件,并添加以下 JSON 配置信息。
- 将 '<YOUR_TOKEN>' 替换为您在安装步骤中获取的 Bitrise API Token。
{ "mcpServers": { "bitrise": { "command": "uvx", "env": { "BITRISE_TOKEN": "<YOUR_TOKEN>" }, "args": [ "--from", "git+https://github.com/bitrise-io/[email protected]", "bitrise-mcp" ] } } }配置参数说明:
- '"bitrise"': 服务器名称,您可以自定义,用于在客户端中标识该服务器。
- '"command": "uvx"': MCP 服务器的启动命令。'uvx' 是使用 'uv' 包管理器运行 Python 脚本的命令。
- '"env": {"BITRISE_TOKEN": "<YOUR_TOKEN>"}': 设置环境变量。'BITRISE_TOKEN' 环境变量用于存储您的 Bitrise API Token,供服务器程序使用。
- '"args": [...]"': 传递给启动命令的参数列表。
- '"--from"': 指定从 Git 仓库安装和运行项目。
- '"git+https://github.com/bitrise-io/[email protected]"': Bitrise MCP Server 的 Git 仓库地址和版本。
- '"bitrise-mcp"': 指定要运行的模块或脚本名称。
-
保存并重启 Claude Desktop:
- 保存 'claude_desktop_config.json' 文件。
- 重启 Claude Desktop 客户端。
-
验证连接:
- 如果配置正确,您应该在 Claude Desktop 的消息输入框旁边看到一个锤子图标,这表示 Bitrise MCP Server 已成功连接。
基本使用方法
成功配置并连接 Bitrise MCP Server 后,您可以在 MCP 客户端中使用自然语言指令与 Bitrise 进行交互。客户端会将您的指令转换为对 Bitrise MCP Server 工具的调用,从而实现对 Bitrise 平台的操作。
例如,您可以使用类似 "列出我的 Bitrise 应用" 或 "触发 [应用名称] 的构建" 这样的指令,来管理您的 Bitrise 应用和构建流程。
限制工具组 (可选):
如果您希望限制暴露给 MCP 客户端的工具数量,可以通过修改 'args' 参数来指定启用的 API 功能组。例如,只启用 'cache-items' 和 'pipelines' 功能组:
{ "mcpServers": { "bitrise": { "command": "uvx", "env": { "BITRISE_TOKEN": "<YOUR_PAT>" }, "args": [ "--from", "git+https://github.com/bitrise-io/[email protected]", "bitrise-mcp", "--enabled-api-groups", "cache-items,pipelines" ] } } }
信息
分类
开发者工具