微信开发者工具 MCP Server
将微信开发者工具 CLI 封装为 MCP (Model Context Protocol) 服务,使编辑器中的 AI 能够直接调用微信 CLI 命令,实现小程序开发、测试、调试、自动化全流程闭环。
🚀 本 MCP Server 已正式提交至官方 MCP Registry,支持跨平台(Windows/macOS)一键安装。
🚀 安装与快速开始
[!IMPORTANT] 在开始之前,请务必提前确认并准备好以下两个路径,您需要在编辑器配置中手动输入它们:
- 微信开发者工具 CLI 路径 (例如:
C:\\Program Files (x86)\\Tencent\\微信web开发者工具\\cli.bat)- 您的小程序项目绝对路径 (例如:
D:\\MyProjects\\mini-app)
1. 基础运行 (推荐)
如果你安装了 uv,可以使用以下命令直接运行,或直接将其配置在编辑器中,而无需手动管理依赖:
uvx wechat-devtools-mcp
[!TIP] 如果提示
uvx命令找不到,请先执行pip install uv。
2. 环境准备 (高级自动化功能必需)
部分高级功能(如 UI 点击、CDP 日志捕获等)依赖 Node.js 环境及自动化 SDK。由于 uvx 是在临时环境中运行,如果您需要使用这些自动化功能,必须先显式安装包并手动安装额外的 npm 依赖。
# 1. 显式全局安装包 (用于下载并定位脚本目录)
uv tool install wechat-devtools-mcp
# 或选用 pip install wechat-devtools-mcp
# 2. 查看包的实际安装路径
uv pip show wechat-devtools-mcp
# 或选用 pip show wechat-devtools-mcp
# 3. 在输出的结果中找到 "Location" 字段(例如 C:\Users\xxx\AppData\Local\Programs\Python\Python313\Lib\site-packages)
# 4. 进入相应的 scripts 目录并安装依赖:
cd "<Location路径>/wechat_devtools_mcp/scripts"
npm install
⚙️ 编辑器配置
Claude Desktop / Antigravity
修改 claude_desktop_config.json 或 mcp_config.json (Antigravity):
{
"mcpServers": {
"wechat-devtools": {
"command": "uvx",
"args": ["wechat-devtools-mcp"],
"env": {
"WECHAT_DEVTOOLS_CLI": "C:\\Program Files (x86)\\Tencent\\微信web开发者工具\\cli.bat",
"WECHAT_PROJECT_PATH": "D:\\Your\\Project\\Path"
}
}
}
}
Cursor / VS Code (MCP Plugin)
在 MCP 控制台中添加新 Server:
- Name:
wechat-devtools - Type:
command - Command:
uvx wechat-devtools-mcp - Environment Variables: 同上添加
WECHAT_DEVTOOLS_CLI和WECHAT_PROJECT_PATH。
🛠️ 工具箱详解 (Toolbox Reference)
本项目提供 44 个 MCP 工具,全方位覆盖小程序全生命周期:
1. 项目感知与上下文 (Context)
wechat_project_info: 获取project.config.json/app.json配置及目录概览。wechat_list_pages: 列出所有注册页面及其文件存在状态。wechat_read_page: 一键读取指定页面的所有源码(WXML/JS/WXSS/JSON)。wechat_read_file: 读取项目中任意文件内容。
2. 构建、预览与编译 (Build)
wechat_compile_check: [最常用] 触发编译并捕获所有 Error 和 Warning。wechat_preview_page: 快捷预览指定页面,支持携带 Query 参数并生成二维码。wechat_build_npm: 构建小程序 NPM 依赖。wechat_upload: 上传代码至微信后台,支持指定版本号和描述。wechat_cache_clean: 清除工具缓存(storage/compile/all 等)。wechat_reset_fileutils: 重建工具内部文件监听。
3. 自动化交互 (Automation v4.0)
需先调用 wechat_auto 开启 9420 自动化端口。
wechat_tap_element: 通过 CSS 选择器模拟用户点击。wechat_input_element: 向 input/textarea 输入文本。wechat_set_page_data: 热更新!直接修改渲染层 Data,免编译刷新预览。wechat_call_page_method: 调用页面中定义的各种 Logic 函数。wechat_get_element_info: 获取元素的 WXML、样式、坐标尺寸等详情。wechat_mock_wx_method: Mock 原生 API 返回值(如支付、位置等)。wechat_call_wx_method: 调用原生wx.xxx接口。wechat_get_page_stack: 获取当前活跃的页面导航栈。
4. 实时调试与日志 (Debug)
wechat_get_cdp_logs: [推荐] 通过 CDP 捕获底层 WXML 警告、底层网络报错。wechat_get_console_logs: 采集指定持续时间内的全量 console 输出。wechat_get_exceptions: 专门监听运行时的 JS Runtime 异常。wechat_capture_screenshot: 捕获当前小程序画面的全屏截图(支持全屏滚动长图)。wechat_navigate_and_capture: 跳转指定页面并自动采集后续 N 秒的日志。wechat_run_automation_script: 执行自定义的 JS 自动化测试脚本。wechat_get_system_info: 获取小程序运行时的真实系统参数。wechat_get_storage: 读取小程序的本地持久化缓存。
5. 云开发管理 (Cloud)
wechat_cloud_env_list: 查看当前 AppID 关联的所有云环境。wechat_cloud_func_list/info: 查阅线上云函数列表与配置。wechat_cloud_func_deploy: 部署、上传并自动安装云函数依赖。wechat_cloud_func_download: 下载线上云函数源码。
6. 系统诊断与管理
wechat_list_tools: [新] 发现工具箱,分类展示所有可用能力。wechat_get_status: 检查 CLI 路径、项目路径及当前账号状态。wechat_login/wechat_is_login: 账号登录态管理。wechat_close_project/wechat_quit_ide: IDE 运行状态控制。
🤖 AI 协作 SOP (最佳实践)
为了达到最佳协作效果,建议按照以下工作流指挥 AI:
- 环境检查与项目启动:
- 调用
wechat_is_login确认登录状态。 - 运行
wechat_open(cdp_enabled=true)打开或刷新项目。注意:务必开启cdp_enabled: true以便后续能够采集到高清运行日志。 - 启动后建议等待 3-5 秒,确保小程序初始化加载完成。
- 调用
- 上下文理解:
- 调用
wechat_project_info获取项目整体配置。 - 调用
wechat_read_page快速读取指定页面的所有相关代码(JS/WXML/WXSS/JSON)。
- 调用
- 循环开发迭代:
- 代码变更:AI 根据需求修改代码。
- 编译校验:执行
wechat_compile_check查看是否有编译错误。如有报错,AI 会根据报错信息自动进行修复。 - 实时预览:通过
wechat_preview_page快速跳转到修改后的页面进行预览。
- 深度调试与质量验收:
- 高清运行日志 (推荐):若逻辑异常或样式警告,调用
wechat_get_cdp_logs。它能捕获比 Console 更底层的 WXML 警告、网络请求报错。 - 自动回归测试:调用
wechat_auto开启自动化,利用wechat_tap_element触发行动,最后使用wechat_capture_screenshot进行视觉验收。
- 高清运行日志 (推荐):若逻辑异常或样式警告,调用
💡 环境变量说明
| 变量名 | 说明 | 默认值 | 必填 |
|---|---|---|---|
WECHAT_DEVTOOLS_CLI | [必须手动确认] 微信开发者工具 CLI 路径 | 无 | 是 |
WECHAT_PROJECT_PATH | [必须手动确认] 默认小程序项目绝对路径 | 无 | 是 |
WECHAT_CLI_TIMEOUT | CLI 命令超时时间(秒) | 60 | 否 |
NODE_PATH | Node.js 执行文件路径 | node | 否 |
参考文档
许可证
MIT