mirroir-mcp
使用说明(Markdown 格式)
-
项目简介
- mirroir-mcp 是一个基于 MCP 的后端服务器实现,设计目标是为 LLM 客户端提供结构化的上下文、可访问的资源、以及外部工具的调用能力,并定义和渲染提示模板,全部通过标准化的 JSON-RPC 协议进行通信。服务器支持多种传输机制,确保在不同场景下都能与客户端稳定对接。
-
主要功能点
- 资源管理(Resources):托管和提供数据资源给客户端访问。
- 工具注册与执行(Tools):注册外部工具,允许 LLM 调用这些工具执行实际任务。
- Prompts 定义与渲染(Prompts):定义可定制的提示模板,并在需要时渲染给客户端使用。
- JSON-RPC 通信:客户端通过 JSON-RPC 请求读取资源、调用工具、获取 Prompts 等,服务器返回标准化的响应。
- 会话管理与能力声明:跟踪会话状态,声明服务器能力,确保安全、可扩展的上下文服务。
- 多传输协议支持:支持通过 STDIO、Server-Sent Events(SSE)、WebSocket 等传输方式与客户端对话。
-
安装步骤
- 在 macOS 上使用方式较为便捷,前提是需要 macOS 15+,并且 iPhone 通过 iPhone Mirroring 与 Mac 连接。
- 安装方式(可选之一):
- 使用 npx 安装并运行(推荐方式之一):npx -y mirroir-mcp
- 使用 Homebrew 安装(需要添加 Tap):brew tap jfarcand/tap && brew install mirroir-mcp
- 从源码运行(更适合开发者):
- 克隆仓库、进入项目、执行构建并运行 Maven/Swift 相关的构建命令(仓库提供了 Swift 构建支持及从源码跑通的流程)。
- 第一次使用时,系统可能会提示进行屏幕录制和辅助功能权限,请按照系统提示完成授权。
-
服务器配置(MCP 客户端需要的最小信息)
- 为了让 MCP 客户端能够连接到服务端,需提供以下配置信息示例(以 JSON 形式表达,描述性注释已写在括号中,便于理解): { "name": "mirroir-mcp", "command": "npx", "args": ["-y", "mirroir-mcp"] }
- 说明:name 为服务器在客户端的标识,command 为启动命令,args 为启动参数。该配置旨在帮助 MCP 客户端将 mirroir-mcp 作为一个后端服务接入到工作流中。实际部署时请按客户端要求填充具体字段,确保服务器可通过所选传输方式对外提供服务。
-
基本使用方法
- 启动服务器:执行上述安装步骤后,运行 mirroir-mcp(或通过 npx/macos 安装脚本触发的默认入口)。服务器启动后将监听并提供 MCP 服务。
- 配置客户端:在支持 MCP 的客户端中,添加一个服务器条目,使用上面的名称、命令和参数(若客户端需要额外的传输配置,请参考客户端文档)。
- 互动方式:客户端通过 JSON-RPC 向服务器请求读取资源、调用工具和获取 Prompts,服务器返回 JSON-RPC 响应。根据需要,客户端可以持续会话并接收能力变化通知等。
- 安全与扩展:服务器实现会进行会话管理和能力声明,便于后续扩展工具和资源,并通过不同传输协议实现灵活的通信方式。