使用说明
项目简介
Operative Web QA Agent 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为 LLM 客户端提供 Web 应用程序的质量评估能力。它通过集成的浏览器自动化工具,能够执行用户体验 (UX) 评估、捕获网络流量和控制台日志,辅助 LLM 进行 Web 应用的自动化测试和问题诊断。
主要功能点
- Web 应用导航与操作: 使用浏览器自动化技术,模拟用户在 Web 应用中的操作,支持 LLM 控制浏览器进行页面浏览和交互。
- 网络流量捕获: 记录 Web 应用的网络请求和响应,为分析性能问题和 API 交互提供数据支持。
- 控制台错误收集: 实时捕获浏览器控制台输出的错误信息,帮助快速定位前端问题。
- 用户体验 (UX) 自动化评估: 通过预定义的任务和 LLM 的智能分析,自动化评估 Web 应用的用户体验,例如导航流畅性、表单易用性等。
- 支持 MCP 协议: 作为 MCP 服务器,能够与 MCP 客户端通过 JSON-RPC 协议进行通信,提供标准化的工具调用接口。
安装步骤
- 获取 API Key: 访问 operative.sh 获取您的 API Key。
- 运行安装脚本: 在 macOS 或 Linux 终端中执行以下命令,安装 Web QA Agent MCP 服务器:
注意: 安装脚本会自动配置环境并启动服务器。请仔细阅读脚本内容,了解其具体操作。bash -i <(curl -LSf https://operative.sh/webagentqa/install.sh) - 配置环境变量: 确保 'OPERATIVE_API_KEY' 环境变量已设置为您在 operative.sh 获取的 API Key。安装脚本通常会自动设置,但您可能需要检查 '.bashrc' 或 '.zshrc' 等配置文件。
服务器配置
MCP 客户端需要配置以下 JSON 格式信息以连接到 Operative Web QA Agent MCP 服务器。
{ "serverName": "web-qa-agent", "command": "python3", "args": [ "mcp_server.py" ], "env": { "OPERATIVE_API_KEY": "<请替换为您的 OPERATIVE_API_KEY>" }, "transport": "stdio" }
配置参数说明:
- 'serverName': 服务器名称,可以自定义,用于在 MCP 客户端中标识该服务器。例如: "web-qa-agent"。
- 'command': 启动服务器的命令。这里使用 'python3',假设您的环境中 Python 3 可执行文件为 'python3'。如果您的环境不同,请修改为相应的 Python 3 命令,例如 'python' 或 '/usr/bin/env python3'。
- 'args': 启动命令的参数。这里使用 'mcp_server.py' 作为参数,指定运行 'mcp_server.py' 文件来启动服务器。
- 'env': 环境变量配置。
- 'OPERATIVE_API_KEY': [必须配置] 您的 Operative.sh API Key,用于服务器进行 API 验证和功能授权。请务必将 '<请替换为您的 OPERATIVE_API_KEY>' 替换为您实际的 API Key。
- 'transport': 传输协议。这里使用 'stdio',表示通过标准输入输出流与 MCP 客户端通信。
请注意:
- 确保 MCP 客户端能够找到 'mcp_server.py' 文件。如果您的工作目录不是仓库根目录,您可能需要调整 'args' 中的路径。
- 首次运行或 API Key 无效时,服务器可能会输出错误信息到标准输出,请关注服务器的日志输出。
基本使用方法
-
启动 MCP 服务器: 按照安装步骤配置并启动 Operative Web QA Agent MCP 服务器。
-
配置 MCP 客户端: 在您的 MCP 客户端中,配置上述服务器连接信息。
-
调用 'web_app_ux_evaluator' 工具: 在 MCP 客户端中,您可以调用名为 'web_app_ux_evaluator' 的工具来评估 Web 应用的用户体验。
- 工具名称: 'web_app_ux_evaluator'
- 参数:
- 'url': 要评估的 Web 应用 URL (字符串类型,必填)。
- 'task': 描述用户体验评估任务的文本 (字符串类型,必填)。例如: "检查网站首页的导航菜单是否易于使用", "测试用户注册流程是否顺畅" 等。
客户端发送 MCP 请求调用 'web_app_ux_evaluator' 工具后,服务器将自动启动浏览器,访问指定的 URL,执行评估任务,并返回包含评估结果、控制台日志和网络请求的 JSON-RPC 响应。
示例: 假设您要评估 'https://example.com' 网站首页的导航菜单易用性。您可以在 MCP 客户端中构造一个调用 'web_app_ux_evaluator' 工具的请求,并设置 'url' 为 '"https://example.com"', 'task' 为 '"检查网站首页的导航菜单是否易于使用"'。服务器将返回对该网站导航菜单的评估报告。
信息
分类
开发者工具