返回 MCP 目录
public公开dns本地运行

playwright-mcp-docker

提供Docker Compose环境来运行Playwright MCP服务器,方便与Cline或Cursor等客户端配合使用。

article

README

🚀 Playwright MCP Docker 环境

本项目提供了一个 Docker Compose 环境,用于运行 @playwright/mcp 服务器。借助该项目,您能够轻松地设置和管理 Playwright MCP 服务器,以便与 Cline 或 Cursor 等客户端配合使用。

🚀 快速开始

先决条件

  • Docker
  • Docker Compose

设置步骤

  1. 克隆仓库
git clone <repository-url>
cd playwright-mcp-docker
  1. 创建 .env 文件 复制示例环境文件:
cp .env.sample .env
  1. 配置 .env 编辑 .env 文件,根据您的环境和偏好调整设置:
  • MCP_HOST_PORT:主机机器上用于访问 MCP 服务器的端口(默认:8931)。
  • HEADLESS:设置为 true 以无头模式运行(无浏览器 GUI),或 false 以有头模式运行(需要 GUI 设置)。默认为 true
  • (仅限有头模式) DISPLAYWAYLAND_DISPLAYXDG_RUNTIME_DIR:在 Linux 环境中用于 GUI 应用程序的环境变量(特别是 WSLg)。已提供默认值。
  • (仅限有头模式) X11_HOST_PATHWSLG_HOST_PATH:X11 和 WSLg 套接字/目录的主机路径。已提供默认值。若系统配置不同,请进行调整。对于 Windows Docker 访问 WSL 路径,使用 \\wsl.localhost\DistroName\... 格式(参见 .env.sample)。

运行服务器

  1. 构建并启动容器
docker-compose up --build -d

--build 标志仅在首次运行或 Dockerfile 更改时需要。-d 标志用于以分离模式运行容器(后台运行)。

  1. 配置 MCP 客户端(例如,VSCode/Cline)
  • 添加或启用名为 playwright_sse 的 MCP 服务器(或任何您喜欢的名称)。
  • 设置连接类型为 SSE
  • 设置 URL 为 http://localhost:<MCP_HOST_PORT>/sse(将 <MCP_HOST_PORT> 替换为 .env 文件中的值,例如 http://localhost:8931/sse)。
  • 示例客户端配置(文件名取决于客户端):
{
    "mcpServers": {
        "playwright_sse": { // 服务器名称任意
            "url": "http://localhost:8931/sse" // 匹配.env文件中的端口号
        }
    }
}

✨ 主要特性

  • 易于设置:通过 Docker Compose 轻松搭建和管理 Playwright MCP 服务器。
  • 模式可选:支持无头和有头两种运行模式,满足不同场景需求。

📦 安装指南

按照上述“设置步骤”和“运行服务器”部分的说明,即可完成 Playwright MCP 服务器的安装和启动。

💻 使用示例

基础用法

按照上述设置和运行步骤,即可启动 Playwright MCP 服务器并配置客户端连接。

高级用法

切换模式

  • 无头模式:使用 HEADLESS=true 以禁用 GUI,适合自动化任务。
  • 有头模式:使用 HEADLESS=false 以启用 GUI,适合需要可视化界面的场景。

📚 详细文档

其他信息

  • .env 文件:用于配置环境变量,如端口和模式设置。
  • docker-compose.yml:定义了如何构建和运行 Docker 服务。
  • Dockerfile:指定了如何构建 Docker 镜像。
  • entrypoint.sh:在容器启动时执行的脚本。

停止服务

docker-compose down

🔧 技术细节

本项目通过 Docker Compose 管理 @playwright/mcp 服务器的运行环境,利用 Docker 容器化技术确保环境的一致性和可移植性。通过 .env 文件配置服务器的运行参数,如端口和运行模式。

📄 许可证

文档中未提及许可证相关信息。

📋 注意事项

⚠️ 重要提示

在 WSLg 环境中运行时,请确保正确设置 DISPLAY 和其他相关环境变量,以便在 Windows 中显示 Linux GUI 应用程序。

💡 使用建议

如果遇到权限问题,请检查 Docker 和 WSLg 的配置,并确保用户具有适当的权限。

通过以上步骤,您可以轻松设置并运行 Playwright MCP 服务器。希望这些说明对您有所帮助!

help

运行方式说明

cloud

托管运行

托管运行通常表示这个 MCP Server 由服务方环境承载,用户一般按页面提供的连接方式或授权流程接入,不需要在本地长期启动一个 MCP 进程

  1. 打开服务方连接页
  2. 完成授权或复制端点
  3. 在 MCP 客户端中连接
terminal

本地运行 / 其它方式

本地运行通常需要用户在自己的电脑或服务器上安装依赖,把 server_config 复制到 MCP 客户端,并按 env_schema 补齐环境变量、密钥或其它配置

  1. 复制 server_config
  2. 安装所需依赖
  3. 补齐环境变量后重启客户端