How do I install the weapp mcp server?

Use a recorded configuration for your client, replace example credential values and paths, and verify the documented runtime. Restart or reconnect the client, then inspect the available tools.

What credentials does it need?

It reads `WEAPP_WS_ENDPOINT`, `WEAPP_AUTOMATOR_MODE`, `WEAPP_PROJECT_PATH`, `WECHAT_DEVTOOLS_CLI_PATH`, `WEAPP_DEVTOOLS_PORT`, `WEAPP_AUTOLAUNCH` from the environment. Store these in your client's env block or a secrets manager — never commit them to a repository — and grant the narrowest scope that still covers your use case.

SSyncDev

Start a project

Weapp MCP Server

Agent-first MCP server for WeChat Mini Program debugging & automation via WeChat DevTools.

Local serverstdio

What is the Weapp MCP Server?

Agent-first MCP server for WeChat Mini Program debugging & automation via WeChat DevTools.

What you get

如果你已经在用 Claude Code / Cursor / Codex 等 agent 写小程序，传统的 miniprogram-automator 脚本式调用不够顺手 — 你得让 agent 写 node 脚本、跑、读输出、再调整。本项目把自动化能力直接暴露成 agent 工具调用，让 agent 在对话中可以：

More MCP options

Compare MCP servers by category, or browse hosted MCP servers if you prefer an endpoint over a local process.

Maintainer setup documentation.

Recorded tools

Check the linked publisher documentation and your connected client's tool list. Names and availability can vary with the server version and account permissions.

Tool	What it does
mp_diagnoseConnection	只诊断当前连接目标，不启动 IDE、不修改项目状态
mp_ensureConnection	确保自动化会话就绪，是连接链路默认入口；失败后再按返回指引诊断或恢复
mp_navigate	在小程序内导航，支持 navigateTo、redirectTo、reLaunch、switchTab 或 navigateBack
mp_screenshot	捕获屏幕截图并返回（或保存到磁盘）
mp_callWx	调用微信小程序 API 方法（如 wx.showToast）
mp_evaluate	向小程序 AppService 注入并执行函数代码，适合做显式运行时读取
mp_pollUntil	轮询 AppService 条件，命中后可执行动作并采集前后状态快照
mp_getLogs	获取小程序控制台日志，支持按 type、contains、since、limit 过滤，并返回日志监听状态（如 listenerAttached、lastLogAt、sessionId）
mp_runScenario	按顺序执行一组最小测试步骤，当前支持 navigate、tap、input、waitRoute、expect*、snapshot、getLogs、screenshot
mp_generateScenarioReport	执行 scenario 并输出 markdown 报告；可选写入 outputPath，适合产出轻量回归测试记录，并可引用截图路径
mp_currentPage	获取当前页面信息（路径、查询参数、尺寸和滚动位置），withData 为 true 时额外返回页面数据
mp_healthCheck	聚合连接、页面、项目路径和日志监听状态，判断当前是否健康、是否需要恢复
mp_recoverConnection	按标准顺序执行恢复，并返回恢复动作、恢复前后状态与最新 health
mp_listProjects	列出微信开发者工具中的最近项目，方便选择项目目录

How to install the Weapp MCP Server

{
  "mcpServers": {
    "weapp-agent-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "@chaixueyuan/weapp-agent-mcp"
      ],
      "env": {
        "WEAPP_WS_ENDPOINT": "ws://localhost:9420"
      }
    }
  }
}

Configuration as documented by the project. Restart the client after saving.

Configuration

Variable	Description	Required
WEAPP_WS_ENDPOINT	Configuration value read at startup.	Optional
WEAPP_AUTOMATOR_MODE	Configuration value read at startup.	Optional
WEAPP_PROJECT_PATH	Filesystem location the server is allowed to use.	Optional
WECHAT_DEVTOOLS_CLI_PATH	Filesystem location the server is allowed to use.	Optional
WEAPP_DEVTOOLS_PORT	Configuration value read at startup.	Optional
WEAPP_AUTOLAUNCH	Configuration value read at startup.	Optional

Example prompts to try

“Use Weapp to mp diagnoseConnection.”
“Use Weapp to mp ensureConnection.”
“Use Weapp to mp navigate.”

Frequently asked questions

Agent-first MCP server for WeChat Mini Program debugging & automation via WeChat DevTools. Confirm the tools offered by your installed version in the connected client. Tool availability and permissions depend on the server and account configuration.