项目简介
Debugg AI MCP 服务器是 Debugg AI 项目官方实现的 Model Context Protocol (MCP) 服务器。它专注于通过标准化协议为大型语言模型 (LLM) 客户端提供端到端测试和浏览器自动化功能。无需复杂的环境设置,AI Agent 即可通过自然语言控制模拟浏览器,执行用户操作流程,测试网页 UI 变化,并获取结果和截图。
主要功能点
- MCP 协议支持: 完全符合 MCP 标准,可与任何兼容的 MCP 客户端(如某些 AI Agent、LLM 开发框架)无缝集成。
- 端到端测试自动化: 允许 AI Agent 根据自然语言描述触发网页 UI 的自动化测试。
- 本地应用集成: 支持对本地开发环境中运行的网页应用进行测试,通过安全隧道连接。
- 实时进度通知: 在测试执行过程中,向客户端发送实时的进度更新信息。
- 截图支持: 测试完成后,可捕获网页的最终视觉状态截图。
- Stdio 兼容: 支持通过标准输入/输出流与 MCP 客户端进行通信。
安装步骤
该服务器可以通过以下两种方式快速启动:
-
使用 NPX (适用于本地开发/测试): 确保您已安装 Node.js 和 npm。 在终端中运行: 'npx -y @debugg-ai/debugg-ai-mcp' 首次运行会自动下载所需文件。
-
使用 Docker: 确保您已安装 Docker。 运行以下命令,请将 'your_api_key', 'your_test_email', 'your_password' 替换为您的 Debugg AI API 密钥及测试用户凭据,并根据您的本地应用信息配置端口、仓库等环境变量: 'docker run -i --rm --init -e DEBUGGAI_API_KEY=your_api_key -e TEST_USERNAME_EMAIL=your_test_email -e TEST_USER_PASSWORD=your_password -e DEBUGGAI_LOCAL_PORT=3000 -e DEBUGGAI_LOCAL_REPO_NAME=your-org/your-repo -e DEBUGGAI_LOCAL_BRANCH_NAME=main -e DEBUGGAI_LOCAL_REPO_PATH=/app -e DEBUGGAI_LOCAL_FILE_PATH=/app/index.ts quinnosha/debugg-ai-mcp'
在启动服务器之前,请确保您已经在 Debugg.AI 网站注册并获取了 API Key。
服务器配置 (为MCP客户端提供)
对于 MCP 客户端(例如某些 AI Agent 或开发框架),您通常需要配置一个连接到此服务器的条目。配置信息通常包含启动服务器的命令及其参数。以下是配置所需的主要信息:
- 名称 (Name): 为此 MCP 服务器连接指定一个标识名称,例如 'debugg-ai-mcp'。
- 命令 (Command): 启动服务器的可执行命令,例如 'npx'。
- 参数 (Args): 传递给命令的参数列表,例如 '["-y", "@debugg-ai/debugg-ai-mcp"]'。
- 环境变量 (Env): 启动服务器时需要设置的环境变量,这是一系列键值对,例如:
- 'DEBUGGAI_API_KEY': 必须,您的 Debugg AI API Key。
- 'DEBUGGAI_LOCAL_PORT': 建议提供,您的本地应用运行的端口号(默认 3000)。
- 'TEST_USERNAME_EMAIL': 测试账号邮箱(可选)。
- 'TEST_USER_PASSWORD': 测试账号密码(可选)。
- 'DEBUGGAI_LOCAL_REPO_NAME': GitHub 仓库名称(可选,用于关联测试结果)。
- 'DEBUGGAI_LOCAL_BRANCH_NAME': 当前分支名称(可选)。
- 'DEBUGGAI_LOCAL_REPO_PATH': 本地仓库的绝对路径(可选)。
- 'DEBUGGAI_LOCAL_FILE_PATH': 要测试的文件的绝对路径(可选)。
MCP 客户端将使用这些信息启动 MCP 服务器进程,并通过 Stdio 协议与其通信。
基本使用方法 (供AI Agent调用)
一旦服务器启动并连接到 MCP 客户端,AI Agent 即可调用服务器提供的工具。此服务器目前主要提供一个名为 'debugg_ai_test_page_changes' 的工具,用于执行自动化测试。
AI Agent 可以通过 MCP 的 'callTool' 请求来调用此工具,并提供以下参数:
- 'description' (字符串, 必需): 自然语言描述您希望测试的页面或功能(例如:"测试注册页面表单")。
- 'localPort' (数字, 可选): 您的本地应用运行端口(默认 3000)。
- 'repoName' (字符串, 可选): GitHub 仓库名称。
- 'branchName' (字符串, 可选): 当前分支名称。
- 'repoPath' (字符串, 可选): 本地仓库的绝对路径。
- 'filePath' (字符串, 可选): 与测试相关的代码文件路径。
服务器接收到请求后,将启动自动化流程,可能涉及建立隧道连接到您的本地应用,模拟用户行为,并最终返回测试结果和相关信息给 AI Agent。测试过程中的进度更新会通过 MCP 通知发送。
有关更多详细信息和用例,请参考项目 README。
信息
分类
开发者工具