MCP Server for WeChat DevTools CLI - 微信开发者工具 MCP 服务
Project description
微信开发者工具 MCP Server (v0.4.0)
将微信开发者工具 CLI 封装为 MCP (Model Context Protocol) 服务,使编辑器中的 AI 能够直接调用微信 CLI 命令,实现小程序开发、测试、调试、自动化全流程闭环。
🚀 本 MCP Server 已正式提交至官方 MCP Registry,支持跨平台(Windows/macOS)一键安装。
🚀 安装与快速开始
[!IMPORTANT] 在开始之前,请务必阅读以下环境准备步骤。
1. 基础环境准备
推荐使用 uv 管理工具,它能自动处理 Python 依赖并提供隔离的执行环境。
① 安装 uv(如已安装可跳过)
pip install uv
② 安装本工具
# 一键安装到全局隔离环境
uv tool install wechat-devtools-mcp --force
③ 开启开发者工具服务端口(重要) 必须手动开启微信开发者工具的 HTTP 服务端口,否则 AI 将无法下发指令:
- 操作路径:
开发者工具->设置->安全设置->服务端口->开启。
④ 确认必要路径 请提前获取以下两个绝对路径,稍后需填入编辑器配置:
- 微信开发者工具 CLI 路径(Windows 一般为
C:\Program Files (x86)\Tencent\微信web开发者工具\cli.bat) - 小程序项目绝对路径(例如
D:\MyProjects\mini-app)
[!TIP]
- 查看版本:
uv tool list- 升级工具:
uv tool upgrade wechat-devtools-mcp
⚙️ 编辑器配置
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-mcp
配置完成后,在 Codex TUI 中输入
/mcp可查看已激活的 MCP 服务。
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。
WECHAT_DEVTOOLS_CLI路径根据实际安装位置调整,注意反斜杠需要转义。
🛠️ 工具箱概要 (Toolbox Reference)
v0.3.0 采用「瘦 MCP + 胖 Skill」架构,提供 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。
🧠 AI Skill(智能协作知识库)
本项目提供配套的 wechat-devtools Skill,可让支持 Agent Skills 协议的 AI 编辑器(如 Kiro、Antigravity 等)自动加载 SOP 流程、参数速查和最佳实践,无需每次手动提示。
安装 Skill
方式一:通过 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 完整参数参考
Skill 包含内容
- 5 个 SOP 流程:初始化、UI 调试、异常排查、全页面巡检、Mock 集成测试
- 能力映射字典:8 个聚合工具 × 全部 action 的快速索引
- CDP 渐进排查策略:concise → full 两阶段,控制 Token 消耗
- 完整参数参考:每个 action 的必填/可选参数、返回示例、常用模板
- 故障排查手册:常见错误码与修复方式
使用方式
安装 Skill 后,在 AI 编辑器中直接描述意图即可,AI 会自动匹配对应 SOP:
"帮我检查所有页面有没有报错" → 自动执行 SOP D(全页面巡检)
"点击登录按钮,截图看看效果" → 自动执行 SOP B(UI 调试流)
"页面白屏了,帮我排查" → 自动执行 SOP C(异常排查流)
"Mock 支付接口,测试支付流程" → 自动执行 SOP E(Mock 集成测试)
💡 环境变量说明
| 变量名 | 说明 | 默认值 | 必填 |
|---|---|---|---|
WECHAT_DEVTOOLS_CLI |
[必须手动确认] 微信开发者工具 CLI 路径 | 无 | 是 |
WECHAT_PROJECT_PATH |
[必须手动确认] 默认小程序项目绝对路径 | 无 | 是 |
WECHAT_CLI_TIMEOUT |
CLI 命令超时时间(秒) | 30 |
否 |
NODE_PATH |
Node.js 执行文件路径 | node |
否 |
❓ 常见问题
如何升级到最新版本?
# 1. 终止可能占用文件的 MCP 进程
Get-Process | Where-Object { $_.ProcessName -like "*wechat-devtools*" } | Stop-Process -Force
# 2. 升级到最新版本
uv tool upgrade wechat-devtools-mcp
为什么 AI 总是报 CLI_TIMEOUT 错误?
最常见原因:微信开发者工具的“服务端口”未开启。
解决方法:进入 设置 -> 安全 -> 服务端口,将其打开。开启后无需重启 IDE,AI 即可恢复连接。
如何解决 uv tool upgrade 提示“另一个程序正在使用此文件”?
这是因为编辑器中的 MCP 服务仍在运行,占用了可执行文件。执行上述“如何升级”中的 Get-Process 命令强制终止进程后重试即可。
wechat_inspector 返回“CDP 采集失败”
如果手动打开了开发者工具,它可能未监听调试端口。请关闭开发者工具,直接让 AI 执行 wechat_ide(action='open', cdp_enabled=True),它会自动以调试模式启动 IDE。
如何查看当前版本?
uv tool list
AI 无法找到微信 CLI 路径?
请在编辑器配置的 env 中确保 WECHAT_DEVTOOLS_CLI 填入了绝对路径,且在 Windows 下使用双反斜杠(如 C:\\...\\cli.bat)。
📋 版本历史
| 版本 | 说明 |
|---|---|
| 0.4.0 | CDP 日志清除(时间戳过滤)与对象序列化增强(preview 展开);云函数 project_path 统一解析与部署自动验证;新增数据库集合管理(db_collection_add/count);navigate 智能提示(page_data 空值诊断);Skill SOP 全面更新(新增 SOP G/H,C/D 重构) |
| 0.3.0 | 重大重构:44 个工具聚合为 8 个 API(wechat_ide/build/automator/inspector/screenshot/navigate/file/cloud);server.py 从 3175 行压缩为 60 行;CDP 日志 v2(结构化 JSON + detail_level + max_logs);新增 cdp_core.js 共享模块;新增 SKILL.md 知识库 |
| 0.2.6 | 文档更新:README 编辑器配置章节新增 OpenAI Codex 配置说明 |
| 0.2.5 | 新增 Kiro 编辑器配置说明 |
| 0.2.4 | 截图滚动拼接修复:将 sharp 替换为纯 JS 的 jimp |
| 0.2.3 | 发布包优化:排除 scripts/ 源码文件,仅保留 scripts/dist/ 构建产物 |
| 0.2.2 | wechat_get_cdp_logs 移入 core 预设;Node.js 脚本改为 bundle-only 模式 |
| 0.2.1 | 版本更新与文档完善 |
| 0.2.0 | wechat_navigate_and_capture 改用 CDP 高清日志采集;core 预设精简为 13 个核心工具 |
| 0.1.9 | fix: 修复源码文件 UTF-8 编码乱码问题 |
| 0.1.8 | fix: Windows 下 uvx 启动时中文路径导致 UnicodeDecodeError |
| 0.1.7 | 新增 WECHAT_TOOLS_PRESET 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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file wechat_devtools_mcp-0.4.0-py3-none-any.whl.
File metadata
- Download URL: wechat_devtools_mcp-0.4.0-py3-none-any.whl
- Upload date:
- Size: 2.3 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f35007f6fb46289fb553cc3c1f5f525666a0fe6b3dba16c1390e57bf79ea3eb7
|
|
| MD5 |
f7e418b317cb45773bba7dd7e83e6395
|
|
| BLAKE2b-256 |
25848590ccbc5135bd5841418324144d98c69fa5bf8e21aa3b8fc9a83ab91992
|