使用说明

项目简介

xcodebuild MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为大型语言模型 (LLM) 客户端提供与 iOS Xcode 项目进行交互的能力。通过此服务器,LLM 可以调用工具来构建和测试 iOS Xcode 工作区或项目,从而实现 iOS 开发流程的自动化,例如在 Visual Studio Code 等编辑器中使用 Cline 或 Roo Code 等扩展时,可以无缝集成 Xcode 构建流程。

主要功能点

  • 构建 (build) iOS Xcode 项目: 允许 LLM 触发 Xcode 构建命令,编译指定的 iOS Xcode 工作区或项目。
  • 测试 (test) iOS Xcode 项目: 允许 LLM 触发 Xcode 测试命令,对指定的 iOS Xcode 工作区或项目运行测试用例。

安装步骤

推荐使用 uv

如果使用 'uv',则无需额外安装。可以使用 'uvx' 直接运行 'mcpxcodebuild'。

使用 PIP

或者,您可以通过 pip 安装 'mcpxcodebuild':

pip install mcpxcodebuild

安装完成后,可以使用以下命令作为脚本运行:

python -m mcpxcodebuild

服务器配置

MCP 服务器需要配置在 MCP 客户端中,以便客户端能够连接和调用服务器提供的功能。以下是 Claude.app 客户端的配置示例,展示了如何配置 xcodebuild MCP Server。

使用 uvx 的配置

{
  "mcpServers": {
    "mcpxcodebuild": {
      "command": "uvx",
      "args": ["mcpxcodebuild"]
    }
  }
}

使用 pip 安装的配置

{
  "mcpServers": {
    "mcpxcodebuild": {
      "command": "python",
      "args": ["-m", "mcpxcodebuild"]
    }
  }
}

配置参数说明:

  • 'mcpServers': 配置 MCP 服务器的根节点。
  • 'mcpxcodebuild': 为该 MCP 服务器自定义的名称,客户端通过此名称引用该服务器。
  • 'command': 启动 MCP 服务器的命令。
    • 使用 'uvx' 时,命令为 'uvx'。
    • 使用 pip 安装时,命令为 'python'。
  • 'args': 启动命令的参数列表。
    • 使用 'uvx' 时,参数为 '["mcpxcodebuild"]',直接运行 'mcpxcodebuild'。
    • 使用 pip 安装时,参数为 '["-m", "mcpxcodebuild"]',以模块方式运行 'mcpxcodebuild'。

基本使用方法

  1. 启动 MCP 服务器: 根据您的安装方式(uv 或 pip),在您的开发环境中启动 'xcodebuild MCP Server'。
  2. 配置 MCP 客户端: 在您的 MCP 客户端(例如 Claude.app 或其他支持 MCP 协议的 LLM 应用)中,根据上述提供的配置信息,添加 'mcpxcodebuild' 服务器配置。确保配置中的 'command' 和 'args' 与您的实际安装情况相符。
  3. 调用工具: 在 MCP 客户端中,您可以使用 'build' 或 'test' 工具。这两个工具都需要一个名为 'folder' 的参数,用于指定 iOS Xcode 工作区或项目所在的文件夹的完整路径。LLM 客户端会根据工具的定义和您的指令,向 MCP 服务器发送 JSON-RPC 请求,服务器执行相应的 Xcode 命令,并将结果返回给客户端。

例如,在 LLM 客户端中,您可以指示其 "使用 xcodebuild MCP Server 的 build 工具构建位于 '/path/to/your/ios/project' 的 iOS 项目"。客户端会将 '/path/to/your/ios/project' 作为 'folder' 参数传递给 'build' 工具。

信息

分类

开发者工具