使用说明
项目简介
MCPXcode 是一个为 Xcode 开发环境设计的 Model Context Protocol (MCP) 服务器。它旨在通过 MCP 协议,将 Xcode 的上下文信息和功能以标准化的方式提供给 AI 助手,从而实现更智能化的开发辅助。该项目包装了 Xcode 常用命令行工具(如 'xcrun', 'xctrace'),并计划利用 macOS 辅助功能实现更深度的 Xcode UI 自动化。
主要功能点
- 集成 Xcode 开发工具: 通过 MCP 协议提供 'xcrun' 和 'xctrace' 等 Xcode 常用命令行工具的访问能力,例如:
- 列出和控制 iOS 模拟器
- 获取 SDK 信息
- 构建、验证和上传 App
- 性能分析和追踪
- 支持 AI 助手: 允许 AI 助手通过调用工具,获取 Xcode 环境信息,执行构建、测试、性能分析等操作,辅助开发者完成日常开发任务。
- 易于扩展: 项目采用模块化设计,方便后续扩展更多 Xcode 工具和功能。
安装步骤
- 安装 uv: 如果你的系统没有安装 uv,请先安装 uv 包管理器 (项目文档中使用 uv 代替 pip,推荐使用 uv)。
curl -LsSf https://astral.sh/uv/install.sh | sh - 克隆仓库: 将 MCPXcode 仓库克隆到本地。
git clone https://github.com/everettjf/MCPXcode.git cd MCPXcode - 创建并激活虚拟环境: 进入仓库目录,创建并激活 Python 虚拟环境。
source .venv/bin/activate - 安装 mcp 库: 使用 uv 安装 'mcp[cli]' 库。
uv add "mcp[cli]"
服务器配置
MCP 服务器需要配置在 MCP 客户端中。以下是 MCPXcode 服务器的配置信息,你需要将其添加到你的 MCP 客户端的配置文件中。
{ "mcpServers": { "MCPXcode": { // 服务器名称,可以自定义 "command": "uv", // 启动服务器的命令,这里使用 uv 运行 Python 脚本 "args": [ "--directory", "<Path>/MCPXcode", // MCPXcode 仓库的**绝对路径**,请替换为你的实际路径 "run", "main.py" // 运行 main.py 启动 MCP 服务器 ] } } }
注意:
- 请将 '<Path>/MCPXcode' 替换为你本地 MCPXcode 仓库的绝对路径。
- 'command' 可以使用 'uv' 的完整路径,如果 'uv' 不在你的 PATH 环境变量中。
- MCP 客户端会根据此配置启动 MCPXcode 服务器,并与之建立连接。
基本使用方法
-
启动 MCP 服务器: 配置完成后,启动你的 MCP 客户端。客户端会根据配置自动启动 MCPXcode 服务器。
-
通过 MCP 客户端与服务器交互: 使用 MCP 客户端,你可以调用 MCPXcode 服务器提供的工具。例如,你可以向 AI 助手发送指令,让其调用 'list_devices' 工具列出 iOS 模拟器,或者调用 'xcrun_build' 工具构建 Xcode 项目。
-
工具调用示例: 以下是一些工具调用的示例,你可以在 MCP 客户端中使用这些工具:
- 列出模拟器设备: 'list_devices'
- 启动模拟器: 'boot_device device_id=<模拟器 UDID>'
- 列出 SDK: 'xcrun_list_sdks'
- 构建 Xcode 项目: 'xcrun_build project_path=<xcodeproj 或 xcworkspace 路径> scheme=<Scheme 名称>'
更多工具和参数信息,请参考仓库的 'README.md' 文档中 "Tool Documentation" 章节。
信息
分类
开发者工具