使用说明

项目简介

chrome-debug-mcp 是一个基于 Model Context Protocol (MCP) 的服务器,旨在作为 LLM 客户端与 Chrome 浏览器之间的桥梁。通过此服务器,LLM 应用能够以标准化的方式控制 Chrome 浏览器执行各种任务,例如网页自动化操作、JavaScript 代码调试、用户脚本注入以及 Chrome 扩展管理。

主要功能点

  • Chrome 浏览器控制: 启动、关闭和配置 Chrome 浏览器,支持自定义 Chrome 路径、用户数据目录和禁用自动化控制横幅。
  • 网页自动化: 模拟用户在网页上的各种操作,包括点击元素、输入文本、选择下拉选项、悬停、等待元素出现、截取网页或元素截图、页面导航和设置视口大小等。
  • 标签页管理: 列出当前所有标签页、打开新标签页、关闭指定标签页、切换标签页。
  • 调试能力: 通过 Chrome 开发者工具协议 (CDP) 提供远程调试功能,捕获控制台日志、实时监控控制台输出、在页面上下文中执行 JavaScript 代码。
  • 用户脚本支持: 支持注入用户脚本,并提供 Greasemonkey 风格的 API (如 'GM_setValue', 'GM_xmlhttpRequest' 等) 以扩展网页功能。
  • 扩展集成: 支持加载未打包的 Chrome 扩展,管理扩展状态和配置。

安装步骤

  1. 前提条件: 确保已安装 Node.js (v14 或更高版本) 和 Chrome 浏览器。
  2. 克隆仓库:
    git clone https://github.com/robertheadley/chrome-debug-mcp.git
    cd chrome-debug-mcp
  3. 安装依赖:
    npm install
  4. 构建项目:
    npm run build

服务器配置

对于 MCP 客户端,您需要配置服务器连接信息。以下是一个 'cline_mcp_settings.json' 示例配置,用于连接到 chrome-debug-mcp 服务器。请注意,MCP 客户端需要配置 MCP 服务器的启动命令及其参数才能建立连接。

{
  "mcpServers": {
    "chrome-debug": { // 服务器名称,客户端使用此名称引用
      "command": "node", // 启动服务器的命令,这里使用 Node.js 运行
      "args": ["path/to/chrome-debug-mcp/build/index.js"], // 启动命令的参数,指向服务器入口文件 build/index.js
      "disabled": false, // 设置为 false 启用此服务器,true 为禁用
      "alwaysAllow": [] // 始终允许访问的工具列表 (可选,例如 ["launch_chrome", "click"])
    }
  }
}

请将 '"path/to/chrome-debug-mcp/build/index.js"' 替换为 'chrome-debug-mcp' 项目中 'build/index.js' 文件的实际绝对路径。

基本使用方法

配置完成后,在 MCP 客户端中,您可以使用 'use_mcp_tool' 函数来调用 chrome-debug-mcp 服务器提供的工具。例如,以下代码展示了如何使用 'launch_chrome' 工具启动 Chrome 浏览器并打开指定的网页:

use_mcp_tool({
  server_name: "chrome-debug", // 使用在服务器配置中定义的服务器名称 "chrome-debug"
  tool_name: "launch_chrome", // 调用服务器提供的 "launch_chrome" 工具,用于启动 Chrome 浏览器
  arguments: {
    url: "https://example.com" // 工具 "launch_chrome" 的参数,指定要打开的网页 URL
  }
})

更多工具和详细的使用方法,请参考仓库中 'docs/COMMANDS.md' 文件,该文件包含了所有可用命令、工具和函数的完整参考。

信息

分类

开发者工具