项目简介

App Store Connect MCP 是一个专为Apple App Store Connect API设计的Model Context Protocol (MCP) 服务器。它将复杂的App Store Connect API封装成一套模块化、易于LLM(大型语言模型)理解和调用的工具集。通过此服务器,LLM客户端可以无缝地访问App Store的评论、管理TestFlight测试、获取分析报告、控制Xcode Cloud CI/CD流程以及执行用户管理操作,而无需直接处理底层的API认证和数据结构。

主要功能点

  • App Store 评论管理:
    • 列出、搜索和获取应用的客户评论,支持按评分、地区、App Store版本、日期范围和评论内容进行筛选。
  • TestFlight 测试管理:
    • 列出、搜索和获取Beta测试崩溃报告,支持按设备型号、操作系统版本、平台、构建ID和测试者ID进行高级筛选,并可获取原始崩溃日志。
  • App Store 分析报告:
    • 列出、创建和获取应用的分析报告请求,支持按访问类型筛选。
    • 列出和获取特定报告的实例,支持按数据粒度、处理日期筛选。
    • 提供下载分析报告数据到TSV文件的功能,方便进一步分析。
  • Xcode Cloud CI/CD 管理:
    • 列出和获取Xcode Cloud产品与工作流信息(只读操作,出于安全考虑不支持创建、更新、删除)。
    • 列出、获取和启动Xcode Cloud构建任务,支持指定分支或Pull Request。
    • 列出构建的产物、问题和测试结果。
    • 列出配置的SCM提供商、Git仓库、Pull Request以及Git引用(分支/标签)。
  • 用户和邀请管理:
    • 列出、获取、修改和删除组织中的用户账户。
    • 列出、获取、创建和删除用户邀请。

安装步骤

  1. 确保Python环境已安装: 本项目需要Python 3.12或更高版本。
  2. 通过PyPI安装:
    pip install app-store-connect-mcp
    如果您想从源代码安装,可以克隆仓库并手动安装:
    git clone https://github.com/gjeltep/app-store-connect-mcp.git
    cd app-store-connect-mcp
    uv pip install -e ".[dev]"

服务器配置

此MCP服务器需要通过环境变量配置App Store Connect API的认证信息。以下是您在启动服务器时需要确保设置的环境变量及其在MCP客户端配置中的对应方式。

MCP客户端通常会以JSON格式定义它要连接的MCP服务器。以下是一个示例JSON配置,展示了如何启动此App Store Connect MCP服务器,并传递必要的认证信息:

{
  "name": "App Store Connect MCP Server",
  "command": [
    "app-store-connect-mcp"
  ],
  "args": [],
  "env": {
    "APP_STORE_KEY_ID": "YOUR_KEY_ID",
    "APP_STORE_ISSUER_ID": "YOUR_ISSUER_ID",
    "APP_STORE_PRIVATE_KEY_PATH": "/path/to/AuthKey_XXXXX.p8",
    "APP_STORE_APP_ID": "YOUR_APP_ID"
  },
  "description": "连接到Apple App Store Connect API,提供应用管理、TestFlight、分析和Xcode Cloud功能。"
}

配置项说明:

  • 'name': MCP服务器的名称,用于客户端识别。
  • 'command': 启动MCP服务器的命令。通常为 'app-store-connect-mcp'。
  • 'args': 启动命令的额外参数。在开发模式下,您可能需要 '["--env-file", ".env"]' 来从 '.env' 文件加载配置。但在生产环境中,环境变量通常直接设置。
  • 'env': 一个字典,包含MCP服务器运行时所需的环境变量。
    • 'APP_STORE_KEY_ID' (必填): 您的App Store Connect API Key ID。
    • 'APP_STORE_ISSUER_ID' (必填): 您的App Store Connect Issuer ID。
    • 'APP_STORE_PRIVATE_KEY_PATH' (必填): 您 '.p8' 格式的私钥文件路径。
    • 'APP_STORE_APP_ID' (可选): 默认的应用ID,如果未在工具调用中显式指定,则使用此ID。
    • 'APP_STORE_KEY_TYPE' (可选): 密钥类型,'team' (默认) 或 'individual'。
    • 'APP_STORE_SCOPE' (可选): 逗号分隔的API权限范围(例如:'READ_REPORTS,ACCESS_APP_ANALYTICS')。
    • 'APP_STORE_SUBJECT' (可选): 仅当 'APP_STORE_KEY_TYPE' 为 'individual' 时需要,指定关联的用户ID。

基本使用方法

  1. 设置环境变量: 在您计划运行服务器的环境中设置上述所需的App Store Connect API认证环境变量。
  2. 运行服务器:
    app-store-connect-mcp
    或者在开发模式下,使用 '.env' 文件:
    cp .env.example .env
    # 编辑 .env 文件填入您的凭据
    app-store-connect-mcp-dev --env-file .env
  3. 连接MCP客户端: 使用任何MCP兼容的客户端(如LLM代理或IDE插件),配置好上述JSON信息,连接到此MCP服务器。服务器将自动声明其提供的所有工具,LLM即可通过这些工具与App Store Connect API进行交互。

信息

分类

开发者工具