Branches Functions Lines Statements Total
分支MCP服务器
 
模型上下文协议（MCP）服务器，用于与分支API交互。
特性
- API全面覆盖： 为分支机构的大多数核心API提供工具，包括深度链接、快速链接、二维码、应用程序管理和查询API。
- 码头化： 设计为轻量级、可移植的Docker容器。
- 灵活配置： 使用环境变量轻松配置凭据和设置。
- 自动化CI/CD： 包括用于自动测试、版本控制和发布到GitHub容器注册表的GitHub操作。
目录
入门指南
此服务器被设计为作为Docker容器运行。
1.构建Docker镜像
从项目目录的根目录，构建Docker镜像：
docker build -t branch-mcp .2.运行Docker容器
运行容器，提供您的Branch凭据作为环境变量。
docker run --rm -it -p 8080:8080 \
-e BRANCH_KEY="key_live_..." \
-e BRANCH_SECRET="secret_live_..." \
-e API_KEY="api_app_..." \
branch-mcp连接方式
本地Docker实例
服务器在本地运行后，使用以下配置连接MCP客户端：
{
"servers": {
"branch-mcp": {
"serverUrl": "http://localhost:8080/mcp"
}
}
}在您的环境中跑步
您可以部署我们的公共Docker镜像(ghcr.io/branchmetricsopensource/branch-mcp-server)到您自己的基础设施（例如Kubernetes、ECS）。您可以按照中所述提供凭据 服务器配置 部分，使内部用户更容易进行身份验证。
分行托管MCP服务器
对于生产使用，您可以直接连接到Branch的托管MCP服务器。使用以下配置：
{
"servers": {
"branch-mcp": {
"serverUrl": "https://ai.branch.io/mcp"
}
}
}托管服务器在运行时没有注入任何身份验证，因此您需要在对它的调用中提供密钥。
服务器配置
可以通过将环境变量传递给Docker容器来配置服务器。虽然大多数凭据可以在每次工具调用时传递，但将其设置为环境变量可以通过建立默认值来简化使用。
| 环境变量 | 描述 | 必填 |
|---|---|---|
BRANCH_KEY | 您的分支密钥。由应用程序、深度链接和每日导出API使用。 | 可选 |
BRANCH_SECRET | 你的分支秘密。由应用程序、深度链接和每日导出API使用。 | 可选 |
API_KEY | 您的分行API密钥（访问令牌）。由v2数据API（自定义、聚合、队列、交叉事件）使用。 | 可选 |
AUTH_TOKEN | 您的分支认证令牌。用于删除深度链接等敏感操作。 | 可选 |
APP_ID | 您的Branch App ID可用于某些数据API。 | 可选 |
ORGANIZATION_ID | 您的分支机构ID可用于某些数据API。 | 可选 |
注： 如果身份验证变量未设置为环境变量，则 必须 在每次调用需要它的工具时，将其作为参数提供。
可用工具
此服务器为以下Branch API提供工具。请参阅 src/apis 目录，了解每个工具参数的完整详细信息。
应用程序API
查看并更新现有的Branch应用程序配置。
branch_get_app_settings：获取Branch应用程序的设置。branch_update_app_settings：更新Branch应用程序的设置。
深度链接API
创建、阅读、更新和删除您的分支链接。
branch_create_deep_link：创建分支深度链接URL。branch_bulk_create_deep_links：在单个请求中创建多个Branch深度链接URL。branch_read_deep_link：读取与Branch深度链接URL关联的数据。branch_update_deep_link：更新分支深度链接URL。branch_delete_deep_link：删除分支深度链接URL。
快速链接API
以编程方式生成在分支仪表板上显示的分支深度链接。
branch_create_quick_link：创建显示在仪表板上的分支快速链接。branch_bulk_create_quick_links：在单个请求中创建多个分支快速链接。branch_update_quick_link：更新现有的分支机构快速链接。
二维码API
通过编程生成和定制Branch驱动的二维码。
branch_create_qr_code：创建分行二维码。
查询API
导出选定的实时活动级数据。
branch_query：使用度量、维度和过滤器查询Branch数据。
每日出口API
每日批量导出所有设备级数据。
branch_get_daily_exports：直接提取细粒度的Branch事件数据。
自定义导出API
使用您自己的过滤器导出选定的设备级数据。
branch_create_custom_export：请求自定义数据导出作业。branch_check_data_readiness：检查给定时间内数据是否已准备好导出。branch_get_export_status：获取自定义数据导出作业的状态。
聚合导出API
拉取针对受限访问用户过滤的聚合分支数据。
branch_create_aggregate_export：请求新的聚合数据导出。branch_get_aggregate_export_status：获取聚合数据导出作业的状态。
队列出口API
提取队列分支数据，以了解用户行为和性能随时间的变化。
branch_create_cohort_export：请求新的队列分析导出。branch_get_cohort_export_status：获取队列数据导出作业的状态。
交叉出口API
查询和比较多个来源的大型数据池。
branch_create_cross_event_export：请求新的跨事件数据导出。branch_get_cross_event_export_status：检索跨事件导出作业的状态。
贡献
请查看我们的 贡献指南 了解如何参与其中。
行为准则
该项目由我们的 行为准则。所有贡献者都应遵守此代码。
更新日志
该项目的所有显著变化都记录在 更新日志.