关于 wechat-devtools-mcp
wechat-devtools-mcp 将 AI 编辑器连接到微信开发者工具,用于小程序开发与测试。七个聚合工具覆盖常见操作,配套 Skill 则提供任务流程和操作指引。
主要功能
- 01IDE 生命周期与环境检查
- 02构建、预览和上传操作
- 03自动交互与运行时查询
- 04CDP 日志采集和页面跳转
- 05长页面拼接截图
- 06读取小程序项目文件
适用场景
- 01编译并预览小程序
- 02自动执行界面交互并检查运行状态
- 03采集页面日志并截取长图
MCP 相关
向 MCP 客户端提供七个聚合工具,用于操作微信开发者工具。README 建议与配套的 wechat-devtools Skill 一起使用。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
uvx wechat-devtools-mcpWECHAT_DEVTOOLS_CLI微信开发者工具 CLI 路径。Windows: C:\Program Files (x86)\Tencent\微信web开发者工具\cli.bat;macOS: /Applications/wechatwebdevtools.app/Contents/MacOS/cliWECHAT_PROJECT_PATH默认小程序项目绝对路径,例如 D:\Projects\MyMiniAppWECHAT_CLI_TIMEOUTCLI 命令超时时间(秒)NODE_PATHNode.js 可执行文件路径WECHAT_CDP_PORTCDP 调试端口默认值;9222 被 Chrome 占用时设为 9333WECHAT_AUTOMATOR_READY_TIMEOUTautomator start 等待首次应答的秒数本地服务需要在你的电脑上安装运行环境(如 Node.js 18+)。各客户端的配置文件位置不同,请参考客户端文档。
工具
本地服务需要在你的电脑上运行后才能读取工具,维护者暂未提供工具列表。
详细介绍
来自项目 README微信开发者工具 MCP Server (v0.9.20)
把微信开发者工具封装为 MCP 服务,让编辑器里的 AI 直接完成小程序的编译、预览、调试、自动化测试闭环。Windows / macOS,已上架官方 MCP Registry。
重要
「瘦 MCP + 胖 Skill」:MCP Server 只提供 7 个聚合工具,操作流程与最佳实践都在配套的 wechat-devtools Skill 里。两者必须一起装。
🤝 与官方能力的关系
微信开发者工具 2.x 自 2026-08-18 起为官方 Stable(1.06 已下架),IDE 内建 MCP Server(47 个原子工具,其中 2 个已废弃)。两者互补,不是替代:
| 场景 | 用谁 |
|---|---|
| 打开项目 / 编译 / 预览 / 上传 / 点击输入 / 云开发 | 2.x 优先官方内建 MCP(wechat_ide(action='status') 的 official_mcp.available 为 true 即可用) |
| 长图拼接截图(固定头尾识别,拍不全如实上报) | 本项目。官方只截视口并压到长边 1280 JPEG |
| CDP 结构化日志(回放采集前的历史、按页面归类、去噪) | 本项目。官方只读缓存 |
| 任务级 SOP(一句话跑完巡检 / 异常排查 / 跨页面校验) | 本项目 Skill |
| 存量 1.06.x(NW.js) | 本项目继续兼容;官方内建 MCP 仅 2.x 有 |
⚠ 官方 IDE 把自家 bridge 注册为
wechat-devtools。本文示例统一用wechat-devtools-mcp避免撞名;旧名配置仍可用,只在同一 agent 同时接入两者时才需区分。
🚀 快速开始
前置条件:Python ≥ 3.10(uv 会自动准备)、Node.js ≥ 18(daemon 依赖 puppeteer-core / jimp)、微信开发者工具 2.x 或 1.06.x。
Step 1 — 安装 MCP Server
pip install uv # 或 brew install uv;已装可跳过
uv tool install wechat-devtools-mcp # 首次安装
uv tool install wechat-devtools-mcp --force --refresh # 升级:--refresh 刷新索引缓存,否则可能装回旧版
wechat-devtools-mcp --version # 确认实际运行版本
警告
曾用
pip install装过旧版的,先pip uninstall wechat-devtools-mcp,否则旧路径优先于 uv。 ≤0.9.10 与 mcp SDK ≥2.0 不兼容(报ModuleNotFoundError: mcp.server.fastmcp),请升到 ≥0.9.11。
升级前先停掉编辑器里正在跑的 MCP 进程(重启编辑器即可)。用 uvx 配置的客户端会复用已缓存的环境、不会自动升级:跑一次 uvx --refresh wechat-devtools-mcp --version 刷新,或在 args 里锁定版本 wechat-devtools-mcp==X.Y.Z。
Step 2 — 开启开发者工具服务端口
开发者工具 → 设置 → 安全设置 → 服务端口 → 开启。不开则 open / compile / preview 等走 CLI 的操作全部报 CLI_TIMEOUT。
Step 3 — 准备两个绝对路径
| 路径 | Windows | macOS |
|---|---|---|
| 开发者工具 CLI | C:\Program Files (x86)\Tencent\微信web开发者工具\cli.bat | /Applications/wechatwebdevtools.app/Contents/MacOS/cli |
| 小程序项目根目录 | D:\MyProjects\mini-app | /Users/<you>/Projects/mini-app |
JSON 里 Windows 路径的 \ 要写成 \\;macOS 的 / 不用转义。
Step 4 — 编辑器配置
标准配置(Claude Desktop / Antigravity / Kiro / Trae / Claude Code .mcp.json 通用):
{
"mcpServers": {
"wechat-devtools-mcp": {
"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"
}
}
}
}
9222 常年被 Chrome 等占用的机器,在 env 里再加一行 "WECHAT_CDP_PORT": "9333"。
| 编辑器 | 配置位置 | 差异 |
|---|---|---|
| Claude Desktop / Antigravity | claude_desktop_config.json / mcp_config.json | 无 |
| Claude Code(项目级) | 仓库根目录 .mcp.json | uvx 走终端 PATH 即可。若编辑器是 GUI 启动(桌面版)报找不到 uvx / node,command 改绝对路径 /opt/homebrew/bin/uvx,并在 env 加 "PATH": "/opt/homebrew/bin:/usr/local/bin:/usr/bin:/bin" 与 "NODE_PATH": "/opt/homebrew/bin/node" |
| Kiro | ~/.kiro/settings/mcp.json | 可加 "autoApprove": ["wechat_ide","wechat_build","wechat_automator","wechat_inspector","wechat_screenshot","wechat_navigate","wechat_file"] |
| Trae ≥1.3 | AI 面板 → 设置 → MCP → 手动配置;或 %APPDATA%\Trae\User\globalStorage\mcp.json / ~/Library/Application Support/Trae/User/globalStorage/mcp.json | 聊天须选 Builder with MCP 智能体;macOS 报找不到 uvx 时同上改绝对路径 |
| Cursor / VS Code | MCP 面板新增 server | Name wechat-devtools-mcp,Command uvx wechat-devtools-mcp,环境变量同上 |
| OpenAI Codex | ~/.codex/config.toml | TOML,见下 |
[mcp_servers.wechat-devtools-mcp]
command = "uvx"
args = ["wechat-devtools-mcp"]
[mcp_servers.wechat-devtools-mcp.env]
WECHAT_DEVTOOLS_CLI = "C:\\Program Files (x86)\\Tencent\\微信web开发者工具\\cli.bat"
WECHAT_PROJECT_PATH = "D:\\Your\\Project\\Path"
Step 5 — 安装 Skill(必须)
npx -y skills add WaterTian/wechat-devtools-mcp/.agents/skills/wechat-devtools
不走 npx skills 的客户端(如 Trae):把仓库的 .agents/skills/wechat-devtools/ 整个复制到小程序项目的 .agents/skills/ 下即可。Skill 含 9 条 SOP、7 工具全 action 速查、CDP 渐进排查策略与故障手册,详见 SKILL.md。
Step 6 — 自检
在编辑器里调一次 wechat_ide(action='status'),下面几项都符合再开工:
| 字段 | 期望 | 不符时 |
|---|---|---|
cli_exists / project_exists / node_available | true | 核对 Step 3 的两个路径;安装 Node.js ≥ 18 |
service_port_enabled | true | 见 Step 2 |
cdp_port_occupant.kind | none 或 ide | foreign 表示端口被别的浏览器占着,设 WECHAT_CDP_PORT=9333 |
skill_version | 等于 mcp_version | 重跑 Step 5 更新 skill 副本 |
🛠️ 工具箱
| 工具 | 用途 | action / 关键参数 |
|---|---|---|
wechat_ide | IDE 生命周期与环境诊断 | open login is_login close quit status |
wechat_build | 构建与发布 | compile preview upload build_npm cache_clean |
wechat_automator | 自动化交互与运行时查询 | start tap input element_info set_data call_method call_wx mock_wx evaluate page_stack page_data system_info storage |
wechat_inspector | 运行时日志采集 | console cdp |
wechat_screenshot | 长图拼接截图 | full_page page_path scroll_top |
wechat_navigate | 跳转并采集 CDP 日志 | page_path |
wechat_file | 项目文件读取 | project_info list_pages read_page read_file |
动作遇到 automator 连接失败会自动 start 一次并重试(返回 auto_recovered);open 成功后 cdp_port 在同一会话内自动沿用,其它工具不必再传。完整参数见 MCP_DOC.md。云函数与云数据库请用 CloudBase MCP。
💡 环境变量
| 变量 | 说明 | 默认 |
|---|---|---|
WECHAT_DEVTOOLS_CLI | 开发者工具 CLI 路径(必填) | — |
WECHAT_PROJECT_PATH | 默认项目根目录(必填) | — |
WECHAT_CLI_TIMEOUT | CLI 超时秒数 | 30 |
WECHAT_CDP_PORT | CDP 调试端口默认值。9222 常被 Chrome 占用时设成 9333;open 成功后同会话其它工具自动沿用 | 9222 |
WECHAT_AUTOMATOR_READY_TIMEOUT | start 等待 automator 首次应答的秒数,大项目冷启动可加大 | 45 |
NODE_PATH | Node.js 可执行文件 | node |
❓ 常见问题
| 症状 | 处理 |
|---|---|
一直报 CLI_TIMEOUT | 服务端口没开,见 Step 2;wechat_ide(action='status') 的 service_port_enabled 可自查 |
| CDP 采集失败 / 采到的全是别的网页 | status 的 cdp_port_occupant.kind 为 foreign 即端口被别的浏览器占着:open(cdp_port=9333) 或设 WECHAT_CDP_PORT,之后其它工具不传端口自动沿用。0.9.19 起 open 会直接报错,不再把别人的页面报错当启动错误 |
automator 9420 连不上 / start 返回 verified=false | 0.9.19 起动作失联会自动 start 一次并重试;start 自带最多 45 秒就绪等待(ready_timeout 可调)。仍失败看 status 的 project_window_open,窗口被关就再 start,不要先 open 重启 IDE |
Windows 中文乱码或 UnicodeDecodeError | env 加 "PYTHONIOENCODING": "utf-8" |
| 装了新版仍跑旧版 | pip uninstall wechat-devtools-mcp;uvx 方式跑 uvx --refresh wechat-devtools-mcp --version;最后以 status 的 mcp_version 为准 |
| IDE 2.x 下工具行为异常 | 注册名与官方 wechat-devtools 撞车,改用 wechat-devtools-mcp |
📋 版本历史
| 版本 | 日期 | 摘要 |
|---|---|---|
| 0.9.20 | 2026-10-26 | call_wx 同步 wx API 自动经 evaluate 直调,不再 10 秒超时;README / MCP_DOC / SKILL 逐字段核对修正;Node.js ≥ 18 门槛明示 |
| 0.9.19 | 2026-10-26 | automator start 按截止时间等就绪,根治「握手未完成」误报;CDP 端口占用检测与会话粘性(WECHAT_CDP_PORT);automator 失联自动恢复;status 新增项目窗口 / skill 版本诊断 |
| 0.9.18 | 2026-09-04 | Windows 2.x 真机闭环:状态目录 User Data 层、就绪判据、quit 等退出、噪音过滤;新增真机冒烟脚本 |
| 0.9.17 | 2026-09-03 | 适配开发者工具 2.x Stable;evaluate 新增 fn_source;open 提速约 4 倍;Windows 1.x/2.x 双轨判定 |
| 0.9.16 | 2026-08-27 | 长页面截图全面修复;源码开源 |
| 0.9.15 | 2026-08-20 | 适配开发者工具 2.x(Electron);修复 CDP 采集自 0.9.0 起恒为 0 条 |
| 0.9.14 | 2026-08-20 | wechat_file 路径口径统一;cdp_port 透传修复 |
| 0.9.13 | 2026-08-18 | --version 早退;文档核对修复 |
完整逐版本说明见 CHANGELOG.md。
参考
- 微信开发者工具 CLI · 小程序自动化 SDK
- 许可证:MIT
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。