使用说明

• 项目简介

  • XC-MCP 是一个基于 MCP 的服务器端实现，旨在为大型语言模型/助手提供与 Xcode 工作流相关的上下文、工具和提示模板。它将资源、工具与提示以标准化的接口暴露给客户端，通过 JSON-RPC 进行请求和响应。

• 主要功能点

  • 资源与数据访问：管理与提供构建日志、产出信息、依赖信息等资源。
  • 工具注册与执行：提供 Xcode、simctl、缓存管理、持久化等工具的统一入口，支持参数化调用与结构化响应。
  • 提示模板与 prompts：定义并渲染与 MCP 交互模式相关的提示模板，方便 LLM 构建对话场景。
  • 会话与能力声明：服务端负责状态管理与能力披露，支持多种传输方式（示例中以 STDIO 为主）。
  • 安全与扩展：模块化设计，易于扩展新的工具与适配器，保留良好的测试覆盖。

• 安装步骤

  • 克隆仓库并进入项目目录。
  • 安装依赖：使用 Node.js 生态的包管理器安装（例如 npm install）。
  • 构建或直接运行源码以启动 MCP 服务器（如：使用编译产物 dist/index.js 运行，或在支持 TS 的运行环境中直接运行源码）。
  • 启动后，服务器将以 MCP 的格式对外提供能力，等待客户端建立连接。

• 服务器配置（MCP 客户端需要的最小信息，请按以下 JSON 配置，客户端无需包含服务器端实现细节）

  • 说明：该配置用于描述如何启动与连接到 XC-MCP 服务器，包含服务器名称、命令与参数，以帮助 MCP 客户端在需要时自动化连接与交互。
  • 配置示例（描述性注释，不包含具体代码块）：
    • serverName: "xc-mcp"
    • command: "node"
    • args: ["dist/index.js"]（若直接运行源码，可改为 ["src/index.ts"]，具体以实际部署方式为准）
    • transport: "stdio"（服务器使用的传输方式，示例中为 STDIO，确保客户端了解默认通信通道）
  • 该配置用于 MCP 客户端在本地启动并通过标准输入输出与服务器对话，确保自动化集成与对话式应用的连通性。

• 基本使用方法

  • 启动服务器后，客户端通过 MCP 的 JSON-RPC 风格请求向服务器请求资源、调用工具、获取 Prompts 等。
  • 客户端可通过工具名（如 xcodebuild-build、simctl-list、persistence-status 等）以结构化、可解析的 JSON 形式获取响应。
  • 服务端处理会话、能力声明，并返回标准化的 JSON-RPC 响应或通知。

• 备注

  • 项目当前使用 TypeScript 实现，核心功能包括对 Xcode 工作流的封装、缓存与持久化等，强调模块化与可扩展性，适合在本地开发环境及与 LLM 的集成场景中使用。