Automates WeChat Developer Tools for WeChat Mini Programs, enabling navigation, inspection, and manipulation of mini-program pages, elements, and components through the miniprogram-automator API.
微信小程序 MCP 服务器
基于 FastMCP 的服务器,通过 miniprogram-automator 自动化微信开发者工具。该服务器提供 MCP 工具,让 AI 助手能够导航、检查和操作小程序页面——类似于 playwright-mcp,但专为微信生态系统定制。
前置要求
已安装微信开发者工具,支持命令行访问(
cli/cli.bat)本地已安装 Node.js 18+ 和
npm有可以在开发者工具中打开的小程序项目
快速开始(npm 包)
@yfme/weapp-dev-mcp 已发布到 npm,普通使用者无需克隆仓库或手动执行 node dist/index.js。下面的命令会直接从 npm 下载可执行版本。
使用 npx 临时运行(推荐)
-y自动确认依赖安装。通过
-p显式钉住@modelcontextprotocol/sdk@1.17.2与fastmcp@3.23.0,可规避新版 SDK 在启动阶段抛出的 “Server does not support completions” 错误。weapp-dev-mcp是包中导出的 CLI 名称。
安装到项目/全局
或使用 npm install -g ... && weapp-dev-mcp。同样需要锁定 SDK 和 fastmcp 的版本。
只有在本仓库内开发时,才建议直接运行
node dist/index.js。一般用户请按照以上 npm 包方式启动。
MCP 客户端集成
配置
要在 Claude Desktop 或其他 MCP 客户端中使用此服务器,请在配置文件中添加:
{ "mcpServers": { "weapp-dev": { "command": "npx", "args": [ "-y", "-p", "@modelcontextprotocol/sdk@1.17.2", "-p", "fastmcp@3.23.0", "-p", "@yfme/weapp-dev-mcp", "weapp-dev-mcp" ], "env": { "WEAPP_WS_ENDPOINT": "ws://localhost:9420" } } } }
启动微信开发者工具
在使用 MCP 服务器之前,需要先启动微信开发者工具并开启 WebSocket 服务。
💡 在开始之前:
打开微信开发者工具
进入 设置 → 安全设置 → 服务端口
开启 "HTTP 调试" 和 "自动化测试"
使用命令行启动
使用命令行启动微信开发者工具并自动开启 WebSocket 服务:
macOS/Linux:
Windows:
其中:
--project参数指定小程序项目目录路径(请替换为实际的项目路径)--auto-port参数指定 WebSocket 服务端口(默认 9420)
⚠️ 警告 由于沙箱机制,部分客户端不允许 MCP 访问项目目录以外的微信开发者工具的 cli,所以这里只介绍了使用 WebSocket 服务
环境变量配置
通过环境变量控制自动化工具如何连接到微信开发者工具:
变量 | 说明 |
| 【推荐】 已运行的开发者工具 WebSocket 端点。设置后,服务器使用
模式而不是启动新实例。示例:
|
| 微信开发者工具 CLI 路径(如果默认路径有效则可选)。 |
| 强制使用
或
模式。除非提供了
,否则默认为
。 |
| 启动开发者工具时的首选端口(回退到可用端口)。 |
| 启动超时时间(毫秒,默认 30000)。 |
| 传递给
用于自动登录。 |
| 启动时传递给
。 |
| 设置为
以在启动时包含
。 |
| 启动时的额外 CLI 参数(空格分隔)。 |
| 传递给开发者工具进程的工作目录。 |
| 设置为
时,每次工具调用后关闭开发者工具会话。 |
注意: 当启动开发者工具(
launch模式)时,必须通过 MCP 工具参数提供小程序项目目录:在执行操作前通过connection.projectPath提供(例如通过mp_ensureConnection)。该值一旦建立,将在后续调用中持久化。
工具调用可以通过 connection 对象覆盖这些默认值中的大部分。
常见错误
Server does not support completions (required for completion/complete)
新版@modelcontextprotocol/sdk在启动阶段强制要求 completions 能力,而当前版本的weapp-dev-mcp尚未实现相关接口。按照“快速开始”章节的命令显式安装@modelcontextprotocol/sdk@1.17.2与fastmcp@3.23.0可立即规避;未来版本将内置兼容逻辑。
可用工具
应用工具(Application Tools)
mp_ensureConnection– 确保自动化会话就绪;可选择强制重连或覆盖连接设置mp_navigate– 在小程序内导航,支持navigateTo、redirectTo、reLaunch、switchTab或navigateBackmp_screenshot– 捕获屏幕截图并返回(或保存到磁盘)mp_callWx– 调用微信小程序 API 方法(如wx.showToast)mp_getLogs– 获取小程序控制台日志,可选择获取后清除
页面工具(Page Tools)
page_getElement– 通过选择器获取页面元素page_waitElement– 等待元素出现在页面上(⚠️ 不适用于自定义组件内部元素)page_waitTimeout– 等待指定的毫秒数page_getData– 获取当前页面的数据对象,可指定路径page_setData– 使用setData更新当前页面的数据page_callMethod– 调用当前页面实例上暴露的方法
元素工具(Element Tools)
element_tap– 通过 CSS 选择器点击 WXML 元素element_input– 向元素输入文本(适用于input和textarea组件)element_callMethod– 调用自定义组件实例的方法(需要 ID 选择器)element_getData– 获取自定义组件实例的渲染数据(需要 ID 选择器)element_setData– 设置自定义组件实例的渲染数据(需要 ID 选择器)element_getInnerElement– 获取元素内的元素(相当于element.$(selector))element_getInnerElements– 获取元素内的元素数组(相当于element.$$(selector))element_getSize– 获取元素大小(宽度和高度)element_getWxml– 获取元素 WXML(内部或外部)
每个工具都接受可选的 connection 块来覆盖环境默认值(项目路径、CLI 路径、WebSocket 端点等)。
使用技巧
一般提示
连接前,在微信开发者工具中启用自动化(
设置 → 安全设置 → 服务端口)推荐首先调用
mp_ensureConnection来验证连接并查看系统/页面详情使用
WEAPP_AUTOCLOSE=true适合无状态的一次性交互导航时始终使用绝对路径(以
/开头):/pages/mine/minetabBar 页面使用
switchTab,普通页面使用navigateTo
操作自定义组件
🔴 重要:必须使用 ID 选择器(如
操作自定义组件时,有两种方法:
方法一:使用 innerSelector 参数(推荐)
适用于 element_tap、element_input、element_getSize、element_getWxml 等工具:
selector:自定义组件的 ID 选择器innerSelector:组件内部元素的选择器
方法二:使用元素内查询工具
适用于 element_getInnerElement 和 element_getInnerElements:
限制说明
page_waitElement不适用于自定义组件内部元素。请使用page_waitTimeout配合元素查询工具进行轮询检查。自定义组件操作(如
element_callMethod、element_getData、element_setData)要求组件具有id属性。