项目简介

Xcode MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器,旨在让 AI 助手能够直接与 Xcode 项目进行交互。通过此服务器,你可以使用 LLM 应用远程触发 Xcode 项目的构建、运行单元测试、监控构建进度并访问详细的日志和报告。

主要功能点

  • 构建 Xcode 项目:支持自定义 Scheme 和 Configuration,让 LLM 应用可以控制构建过程。
  • 运行单元测试:支持运行项目中的单元测试,并可指定运行特定测试或跳过某些测试,方便 LLM 应用进行测试驱动的开发。
  • 生成代码覆盖率报告:在运行测试时自动生成代码覆盖率报告,帮助评估测试质量。
  • 实时流式传输日志:构建和测试过程中的日志可以实时流式传输到客户端,方便监控进度和问题排查。
  • 访问详细报告:提供详细的构建和测试报告,包括 JSON 和文本格式,方便 LLM 应用进行结果分析。
  • 日志持久化:所有操作日志自动保存到本地目录,方便后续查阅和审计。

安装步骤

  1. 克隆仓库:在终端中执行 'git clone https://github.com/PolarVista/Xcode-mcp-server.git' 克隆项目代码到本地。
  2. 进入目录:使用 'cd xcode-mcp-server' 命令进入项目目录。
  3. 安装依赖:运行 'npm install' 安装项目所需的 Node.js 依赖包。
  4. 构建服务器:执行 'npm run build' 命令编译 TypeScript 代码,生成可执行的 JavaScript 服务器文件。

服务器配置

要将 Xcode MCP Server 集成到 MCP 客户端(例如 Claude Desktop),你需要配置以下 JSON 格式的服务器信息。客户端将使用这些信息来启动和连接到服务器。

{
  "serverName": "xcode-build",
  "command": "node",
  "args": [
    "/path/to/the/xcode-mcp-server/build/index.js",
    "/path/to/your/build/logs/directory"  // 请替换为实际的日志存储目录路径,例如 "/Users/yourname/xcode-build-logs"
  ],
  "env": {
    "PATH": "/usr/bin:/bin:/usr/local/bin:/usr/sbin:/sbin"
  }
}

配置参数说明:

  • '"serverName"': 服务器的名称,客户端用以识别,例如 '"xcode-build"'。
  • '"command"': 启动服务器的命令,这里是使用 Node.js 运行 JavaScript 文件,所以设置为 '"node"'。
  • '"args"': 传递给启动命令的参数数组。
    • 第一个参数 '/path/to/the/xcode-mcp-server/build/index.js' 必须替换为 'index.js' 文件在你的系统中的绝对路径。这个文件是编译后的服务器主程序。
    • 第二个参数 '/path/to/your/build/logs/directory' 必须替换为 你希望 存储 Xcode 构建日志的本地目录的绝对路径。服务器会在这个目录下创建子目录来存放日志文件。
  • '"env"': 可选的环境变量配置。'PATH' 环境变量确保服务器可以找到 'xcodebuild' 等 Xcode 命令行工具。

基本使用方法

  1. 启动服务器:打开终端,进入 'xcode-mcp-server' 目录,执行命令 'npm run start /path/to/build/logs/directory',并将 '/path/to/build/logs/directory' 替换为你配置中指定的日志存储目录路径。服务器启动后,将在终端输出 "Xcode Build MCP server running on stdio" 等信息。
  2. 配置 MCP 客户端:在你的 MCP 客户端(如 Claude Desktop)中,根据客户端的指引,添加或配置新的服务器连接。将上面提供的 JSON 配置信息粘贴到客户端的服务器配置中。确保路径配置正确。
  3. 使用 LLM 应用调用工具:在 LLM 应用中,你可以使用 'build_project' 和 'run_tests' 这两个工具来操作 Xcode 项目。
    • 'build_project' 工具: 用于构建 Xcode 项目。你需要提供 'projectPath' (项目文件路径) 和 'scheme' (构建 Scheme 名称) 等参数。
    • 'run_tests' 工具: 用于运行 Xcode 项目的单元测试。你需要提供 'projectPath' (项目文件路径) 和 'scheme' (测试 Scheme 名称) 等参数,还可以选择性地指定要运行的测试或跳过的测试。
  4. 查看日志和报告:构建和测试完成后,你可以在配置的日志存储目录下找到详细的日志文件和报告。最新的日志内容也可以通过资源 'xcode-build://latest-log' 在 MCP 客户端中访问。

信息

分类

开发者工具