使用说明

项目简介

XcodeBuildMCP 是一个实现了 Model Context Protocol (MCP) 的服务器,旨在为 AI 助手和其它 MCP 客户端提供与 Xcode 交互的能力。它通过标准化的 MCP 协议,将 Xcode 的常用操作(如构建、清理、模拟器管理等)封装成一系列工具,使 AI 能够更方便、更可靠地控制 Xcode,自动化 iOS 和 macOS 应用的开发流程。

主要功能点

  • Xcode 项目管理
    • 构建操作:支持 macOS、iOS 模拟器和 iOS 设备等多种目标平台的构建。
    • 项目信息:可以列出 Xcode 项目的 schemes 和显示构建设置。
    • 清理操作:清理 Xcode 构建产物。
  • 模拟器管理
    • 模拟器控制:列出、启动和打开 iOS 模拟器。
    • 应用部署:在 iOS 模拟器上安装和启动应用。
  • 应用工具
    • Bundle ID 提取:从 iOS 和 macOS 应用 bundle 中提取 Bundle Identifier。
    • 应用启动:在模拟器和 macOS 上启动已构建的应用。

安装步骤

  1. 安装 Xcode 命令行工具 确保您的系统已安装 Xcode 及其命令行工具。您可以通过在终端中运行 'xcode-select --install' 进行安装。
  2. 安装 Node.js 和 npm 确保您的系统已安装 Node.js (v16 或更高版本) 和 npm。您可以从 Node.js 官网 下载安装包进行安装。如果您已经安装了 mise,则可以跳过此步骤。
  3. 克隆仓库 使用 'git clone https://github.com/cameroncooke/XcodeBuildMCP' 命令克隆仓库到本地。
  4. 安装依赖 进入克隆的仓库目录,运行 'npm install' 命令安装项目依赖。
  5. 构建项目 运行 'npm run build' 命令构建项目。
  6. 启动服务器 运行 'node build/index.js' 命令启动 MCP 服务器。服务器默认通过标准输入输出 (stdio) 与客户端通信。

服务器配置

MCP 服务器需要配置在 MCP 客户端中才能使用。以下是配置 XcodeBuildMCP 服务器的 JSON 格式配置信息,您需要将其添加到您的 MCP 客户端配置中(例如 Cursor, Claude Desktop 等)。

使用 mise 启动 (推荐) 如果您安装了 'mise',可以使用以下配置,'mise' 会自动处理 Node.js 和 'xcodebuildmcp' 的安装和启动:

{
  "mcpServers": {
    "XcodeBuildMCP": {
      "command": "mise",
      "args": [
        "x",
        "npm:xcodebuildmcp@latest",
        "--",
        "xcodebuildmcp"
      ]
    }
  }
}
  • 'server name': 'XcodeBuildMCP' (服务器名称,在客户端中用于标识该服务器)
  • 'command': 'mise' (启动服务器的命令,这里使用 mise)
  • 'args': 启动参数,包括:
    • 'x': mise 的执行命令
    • 'npm:xcodebuildmcp@latest': 使用 npm 安装并运行最新版本的 'xcodebuildmcp' 包
    • '--': 分隔 mise 命令和 'xcodebuildmcp' 命令的参数
    • 'xcodebuildmcp': 'xcodebuildmcp' 包的入口命令

使用 npx 启动 (需要预装 Node.js 环境) 如果您已经有 Node.js 环境,并且希望直接使用 'npx' 启动,可以使用以下配置:

{
  "mcpServers": {
    "XcodeBuildMCP": {
      "command": "npx",
      "args": [
        "xcodebuildmcp"
      ]
    }
  }
}
  • 'server name': 'XcodeBuildMCP' (服务器名称)
  • 'command': 'npx' (启动服务器的命令,这里使用 npx)
  • 'args': 启动参数,包括:
    • 'xcodebuildmcp': 'xcodebuildmcp' 包的入口命令 (假设您已经全局或在项目本地安装了 'xcodebuildmcp' 包)

配置说明

  • 请根据您的环境选择合适的配置方式。推荐使用 'mise' 方式,它可以简化环境配置。
  • 将上述 JSON 配置添加到您的 MCP 客户端的 'mcpServers' 配置节中。具体的配置方法请参考您使用的 MCP 客户端的文档。
  • 启动 MCP 客户端后,客户端会自动连接到 XcodeBuildMCP 服务器。

基本使用方法

  1. 连接服务器: 确保您的 MCP 客户端已正确配置并成功连接到 XcodeBuildMCP 服务器。
  2. 发现工具: 客户端通常会自动发现服务器提供的工具。您可以在客户端的工具面板或命令列表中找到以 'macos_build'、'ios_simulator_build_by_name'、'list_simulators' 等命名的工具。工具名称可能会带有 'mcp0_' 前缀。
  3. 调用工具: 根据您的需求,选择合适的工具进行调用。例如,您可以使用 'list_schemes' 工具列出 Xcode 项目的 schemes,使用 'ios_simulator_build_by_name' 工具构建 iOS 模拟器应用,使用 'boot_simulator' 工具启动模拟器等。
  4. 查看结果: 工具执行结果会以文本、资源等形式返回到客户端。您可以根据返回的信息进行后续操作,例如获取应用路径、安装应用到模拟器、启动应用等。

示例工具调用 (在 MCP 客户端中)

  • 列出 schemes: 'list_schemes({ workspacePath: '/path/to/your/workspace.xcworkspace' })'
  • 构建 macOS 应用: 'macos_build({ workspacePath: '/path/to/your/workspace.xcworkspace', scheme: 'MyAppScheme' })'
  • 列出模拟器: 'list_simulators({})'
  • 启动模拟器: 'boot_simulator({ simulatorUuid: 'YOUR_SIMULATOR_UUID' })'

请注意,具体的工具参数和使用方式请参考工具的描述信息,您可以在 MCP 客户端中查看工具的详细描述。

信息

分类

开发者工具