使用说明

项目简介

Minium MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为 LLM 应用提供操作和控制微信小程序的能力。通过该服务器,LLM 可以利用预定义的工具,实现小程序的自动化测试、数据获取、以及模拟用户操作等功能。

主要功能点

  • 微信小程序自动化控制: 提供一系列工具,允许 LLM 客户端控制微信小程序,例如页面跳转、元素点击、输入文本、截图等操作。
  • 基于 MCP 协议: 遵循 MCP 协议标准,易于与各种 MCP 客户端集成,实现标准化的上下文服务。
  • 工具化操作: 将小程序操作封装为工具 (Tools),方便 LLM 理解和调用,降低 LLM 使用复杂 API 的难度。
  • Stdio 传输协议: 使用 Stdio 作为默认传输协议,方便部署和集成。

安装步骤

  1. 安装 Python 依赖: 确保你的 Python 环境中已安装必要的库,可以通过 pip 安装:

    pip install -e server/  # 或者进入 server 目录执行 pip install .
    pip install minium mcp-server-py

    注意: '-e server/' 假设你希望以可编辑模式安装 'server' 目录下的代码。如果直接下载 zip 包,可能需要先解压,然后进入解压后的 'server' 目录执行 'pip install .'

  2. 安装微信开发者工具 (如果需要本地运行小程序): Minium MCP Server 依赖微信开发者工具来运行和控制小程序。请确保已安装微信开发者工具,并根据你的操作系统配置好开发者工具的 CLI 路径(代码中已包含 macOS 和 Windows 的默认路径)。

服务器配置

MCP 客户端需要配置以下信息才能连接到 Minium MCP Server。配置信息为 JSON 格式:

{
  "serverName": "minium-mcp-server",
  "command": "python -m minium_mcp_server.server",
  "args": ["--path", "./MiniProgram"]
}

参数说明:

  • 'serverName': 服务器名称,可以自定义,用于标识该服务器。
  • 'command': 启动 Minium MCP Server 的命令。这里使用 'python -m minium_mcp_server.server' 直接运行 'server/src/minium_mcp_server/server.py' 模块。
  • 'args': 传递给服务器的命令行参数,以列表形式提供。
    • '--path': 必填参数,指定你的微信小程序项目根目录的路径。请将 '"./MiniProgram"' 替换为你的实际项目路径。例如,如果你的小程序项目在 '/Users/username/my_miniprogram',则应配置为 '["--path", "/Users/username/my_miniprogram"]'。

基本使用方法

  1. 启动 MCP 服务器: 在安装并配置完成后,MCP 服务器会在 MCP 客户端尝试连接时自动启动(如果 MCP 客户端支持自动启动)。或者,你也可以手动在命令行中执行配置中的 'command' 和 'args' 命令来启动服务器。

  2. 配置 MCP 客户端: 在你的 MCP 客户端应用中,配置连接到 Minium MCP Server。你需要提供上面 服务器配置 中生成的 JSON 信息。

  3. 使用 LLM 调用工具: 配置完成后,你的 LLM 应用应该能够通过 MCP 客户端连接到 Minium MCP Server,并发现和调用服务器提供的工具。例如,LLM 可以调用 'navigate_to' 工具来导航到小程序的某个页面,或者调用 'tap' 工具来点击页面上的某个元素。

请注意:

  • 首次运行可能需要确保微信开发者工具已打开,并且项目已导入到开发者工具中。
  • 'connector' 目录下的代码 'miniSock.py' 和 'connector/src' 似乎是早期或另一种实现方式,推荐使用 'server' 目录下的代码作为 MCP 服务器。

信息

分类

开发者工具