Playwriter MCP 服务器

使用说明

  • 项目简介
    • Playwriter 是一个结合浏览器自动化和 MCP(Model Context Protocol)的端到端工具集,核心包含一个 MCP 服务器实现,能够通过 JSON-RPC 与客户端协作,提供资源数据、工具执行和 Prompt 渲染等能力,适用于将浏览器自动化能力暴露给 LLM 客户端进行上下文驱动的对话式任务处理。
  • 主要功能点
    • MCP 服务器核心:实现资源(Resource)、工具(Tools)与 Prompts 的标准化管理与渲染,提供会话管理和能力声明。
    • JSON-RPC 通信:服务器通过 JSON-RPC 处理请求,并返回相应的 JSON-RPC 响应或通知。
    • 资源托管与访问:允许客户端读取与查询资源,用于向 LLM 客户端提供数据上下文。
    • 工具注册与执行:注册可供 LLM 调用的工具,执行外部功能。
    • Prompt 定义与渲染:定义与渲染 Prompt 模板,支持可定制的交互模式。
    • 与 relay/执行器集成:通过本仓库的 relay 服务、CDP Relay、以及 Playwright.Executor 实现对浏览器的远程控制和执行。
    • 安全与多传输:实现本地与远程访问、Origin/Token 校验,以及对接收客户端的传输协议(如 Stdio 等)。
  • 安装步骤
      1. 安装依赖
      • 在项目根目录执行安装命令,确保 Node.js 环境就绪。
      1. 构建与启动
      • 使用仓库提供的命令启动 MCP 服务器(通常通过 Playwriter CLI 入口启动 MCP 服务并连接 relay)。
      1. 配置访问
      • 若需要远程访问,按需求开启 Relay 服务并配置安全令牌与主机地址。
      1. 验证
      • 使用 MCP 客户端连接,按 MCP 协议约定发送请求(如读取资源、调用工具、获取 Prompt 等),验证返回结果。
  • 服务器配置(示例,供 MCP 客户端生成连接信息使用)
    • server_name: "playwriter-mcp-server"
    • command: "node"
    • args: [ "path/to/mcp-entry.js", "--port","19988", "--host","127.0.0.1" ] 注释:
    • server_name 指定 MCP 服务器的标识名称。
    • command 与 args 指定 MCP 客户端连接服务器所需的启动命令与参数。实际参数请根据你的部署环境、端口和是否启用远程 relay 进行调整。
  • 基本使用方法
    • 启动服务后,MCP 客户端可通过 JSON-RPC 请求与服务器交互,常见流程包括:
      • 读取资源以获取数据上下文
      • 注册并执行工具以调用外部功能
      • 获取并渲染 Prompt 模板用于与 LLM 的交互
    • 客户端可以通过指定服务器地址、令牌等信息建立连接,并在需要时向 MCP 服务器请求资源、工具、Prompts 等能力。

服务器信息