将微信开发者工具 CLI 封装为 MCP (Model Context Protocol) 服务,使编辑器中的 AI 能够直接调用微信 CLI 命令,实现小程序开发、测试、调试、自动化全流程闭环。
Important
本项目采用「瘦 MCP + 胖 Skill」架构:MCP Server 提供 8 个聚合 API,配套的 wechat-devtools Skill 提供 SOP 流程、参数速查和最佳实践。两者必须配合使用,缺少 Skill 时 AI 将无法按正确流程操作小程序。
已发布至官方 MCP Registry,支持跨平台(Windows / macOS)一键安装。
推荐使用 uv,它能自动处理 Python 依赖并提供隔离的执行环境。
pip install uv # 安装 uv(如已安装可跳过)
uv tool install wechat-devtools-mcp --force # 一键安装到全局隔离环境Tip
- 查看已安装版本:
uv tool list - 升级工具:如果编辑器正在运行 MCP 服务,需先终止进程再升级:
# Windows PowerShell Get-Process | Where-Object { $_.ProcessName -like "*wechat-devtools*" } | Stop-Process -Force uv tool upgrade wechat-devtools-mcp
Warning
必须手动开启,否则 AI 将无法下发任何指令。
操作路径:开发者工具 → 设置 → 安全设置 → 服务端口 → 开启
请提前获取以下两个绝对路径,稍后需填入编辑器配置:
| 路径 | 示例 |
|---|---|
| 微信开发者工具 CLI | C:\Program Files (x86)\Tencent\微信web开发者工具\cli.bat |
| 小程序项目根目录 | D:\MyProjects\mini-app |
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"
}
}
}
}Kiro
编辑 ~/.kiro/settings/mcp.json:
{
"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",
"PYTHONIOENCODING": "utf-8"
},
"autoApprove": [
"wechat_ide", "wechat_build", "wechat_automator", "wechat_inspector",
"wechat_screenshot", "wechat_navigate", "wechat_file", "wechat_cloud"
]
}
}
}OpenAI Codex
编辑 ~/.codex/config.toml(全局)或 .codex/config.toml(项目级):
[mcp_servers.wechat-devtools]
command = "uvx"
args = ["wechat-devtools-mcp"]
[mcp_servers.wechat-devtools.env]
WECHAT_DEVTOOLS_CLI = "C:\\Program Files (x86)\\Tencent\\微信web开发者工具\\cli.bat"
WECHAT_PROJECT_PATH = "D:\\Your\\Project\\Path"也可以通过 CLI 快速添加:
codex mcp add wechat-devtools \
--env WECHAT_DEVTOOLS_CLI="C:\\Program Files (x86)\\Tencent\\微信web开发者工具\\cli.bat" \
--env WECHAT_PROJECT_PATH="D:\\Your\\Project\\Path" \
-- uvx wechat-devtools-mcpCursor / VS Code (MCP Plugin)
在 MCP 控制台中添加新 Server:
- Name:
wechat-devtools - Type:
command - Command:
uvx wechat-devtools-mcp - Environment Variables: 同上添加
WECHAT_DEVTOOLS_CLI和WECHAT_PROJECT_PATH
Windows 下路径中的反斜杠需要转义(
\\)。
Important
本 MCP 必须配合 wechat-devtools Skill 使用。 Skill 包含 AI 操作小程序所需的全部 SOP 流程、参数速查和故障排查指南。未安装 Skill 时,AI 只能调用裸 API,无法自动执行标准化测试和调试流程。
方式一:通过 GitHub 仓库引用(推荐)
npx skills add WaterTian/wechat-devtools-mcp/.agents/skills/wechat-devtools方式二:手动复制
将 .agents/skills/wechat-devtools/ 目录复制到你的项目或全局 skills 目录:
.agents/skills/
└── wechat-devtools/
├── SKILL.md # 主指令文件(SOP + 能力映射 + 红线规则)
└── references/
└── tool_reference.md # 8 个聚合 API 完整参数参考
MCP Server 提供 8 个聚合工具,覆盖小程序全生命周期:
| 工具 | 功能 | 支持的 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 |
界面截图(长图拼接) | — |
wechat_navigate |
跳转页面并采集 CDP 日志 | — |
wechat_file |
项目文件读取 | project_info list_pages read_page read_file |
wechat_cloud |
云函数与数据库管理 | env_list func_list func_info func_deploy func_download db_collection_add db_collection_count |
完整工具参数说明请参阅 MCP_DOC.md
Skill 让 AI 在收到自然语言指令后,自动匹配并执行标准化操作流程:
| 你说的话 | AI 执行的流程 |
|---|---|
| "帮我检查所有页面有没有报错" | SOP D — 全页面巡检 |
| "点击登录按钮,截图看看效果" | SOP B — UI 调试 |
| "页面白屏了,帮我排查" | SOP C — 异常排查 |
| "Mock 支付接口,测试支付流程" | SOP E — Mock 集成测试 |
| "测试详情页,参数名是什么" | SOP G — 子页面测试 |
| "部署云函数并验证是否生效" | SOP H — 云函数部署验证 |
| "对比各页面积分是否一致" | SOP I — 跨页面数据校验 |
- 10 个 SOP 流程 — 初始化、UI 调试、异常排查、全页面巡检、Mock 集成测试、网络调试与 UI 适配、子页面测试、云函数部署验证、跨页面数据校验、并行数据比对
- 能力映射字典 — 8 个聚合工具 × 全部 action 的快速索引
- CDP 渐进排查策略 — concise → full 两阶段,控制 Token 消耗
- 完整参数参考 — 每个 action 的必填/可选参数、返回示例、常用模板
- 故障排查手册 — 常见错误码与修复方式
安装方式见 Step 5 — 安装 Skill
| 变量名 | 说明 | 默认值 | 必填 |
|---|---|---|---|
WECHAT_DEVTOOLS_CLI |
微信开发者工具 CLI 路径 | — | 是 |
WECHAT_PROJECT_PATH |
默认小程序项目绝对路径 | — | 是 |
WECHAT_CLI_TIMEOUT |
CLI 命令超时时间(秒) | 30 |
否 |
NODE_PATH |
Node.js 执行文件路径 | node |
否 |
为什么 AI 总是报 CLI_TIMEOUT 错误?
最常见原因:微信开发者工具的"服务端口"未开启。
进入 设置 → 安全 → 服务端口,将其打开。开启后无需重启 IDE,AI 即可恢复连接。
wechat_inspector 返回"CDP 采集失败"
如果手动打开了开发者工具,它可能未监听调试端口。请关闭开发者工具,让 AI 执行 wechat_ide(action='open', cdp_enabled=True) 以调试模式启动。
uv tool upgrade 提示文件被占用?
编辑器中的 MCP 服务仍在运行。参见 Step 1 下方的升级提示——需先终止进程再升级。
AI 无法找到微信 CLI 路径?
在编辑器配置的 env 中确保 WECHAT_DEVTOOLS_CLI 填入了绝对路径,Windows 下使用双反斜杠(如 C:\\...\\cli.bat)。
| 版本 | 说明 |
|---|---|
| 0.7.0 | navigate 变量作用域修复(currentPageTimeout);evaluate 支持声明语句(const/let/var fallback);call_method 返回当前页面路径;automator start 端口轮询验证替代盲等;SKILL.md 新增效率原则、恢复分级、页面跳转方法、6 条故障条目 |
| 0.6.0 | navigate 支持 query 参数(reLaunch 超时 fallback);CDP 启动噪音过滤(console.assert/__route__/ide:// 降噪 + WXML 错误保护);compile 返回值三分类 + automator 失效提示;navigate currentPage 轮询重试;超时可配置 |
| 0.5.1 | wechat_ide(action='open') 新增 CDP 启动健康检查:自动采集 5 秒 CDP 日志检测启动阶段致命错误,有错误直接返回失败阻止后续操作 |
| 0.5.0 | Skill SOP 全面优化:新增 SOP I/J;增加 AppID 检查与 path 校验;CDP 噪音过滤;截图拼接模糊匹配修复 |
| 0.4.1 | 截图长页面拼接重写:固定区域检测、DPR 自适应、动态重叠计算 |
| 0.4.0 | CDP 日志增强、云函数部署自动验证、navigate 智能诊断、新增 SOP G/H |
| 0.3.0 | 重大重构:44 个工具聚合为 8 个 API;CDP 日志 v2;新增 SKILL.md 知识库 |
更早版本
| 版本 | 说明 |
|---|---|
| 0.2.6 | README 新增 OpenAI Codex 配置说明 |
| 0.2.5 | 新增 Kiro 编辑器配置说明 |
| 0.2.4 | 截图滚动拼接修复:sharp → jimp |
| 0.2.3 | 发布包优化:排除 scripts/ 源码,仅保留 dist/ 构建产物 |
| 0.2.2 | Node.js 脚本改为 bundle-only 模式 |
| 0.2.1 | 版本更新与文档完善 |
| 0.2.0 | navigate 改用 CDP 高清日志采集 |
| 0.1.9 | 修复 UTF-8 编码乱码 |
| 0.1.8 | 修复 Windows 中文路径 UnicodeDecodeError |
| 0.1.7 | 新增 core/full 工具集预设;新增 MCP_DOC.md |
| 0.1.6 | wechat_open(cdp_enabled=true) 自动 kill 已有进程 |
| 0.1.5 | 修复 Windows stdio 阻塞问题 |
| 0.1.4 | 添加 CDP 日志、截图、自动化等功能 |
| 0.1.3 | 初始版本 |
MIT