🚀 Playwright MCP Docker 环境

本项目提供了一个 Docker Compose 环境，用于运行 @playwright/mcp 服务器。借助该项目，你能够轻松完成 Playwright MCP 服务器的设置与管理，进而与 Cline 或 Cursor 等客户端协同使用。

🚀 快速开始

先决条件

• Docker
• Docker Compose

设置

1. 克隆仓库

   git clone <repository-url>
   cd playwright-mcp-docker
   

2. 创建 .env 文件 复制示例环境文件：

   cp .env.sample .env
   

3. 配置 .env 编辑 .env 文件，依据你的环境和偏好调整设置：
   • MCP_HOST_PORT：主机机器上用于访问 MCP 服务器的端口（默认：8931）。
   • HEADLESS：设置为 true 以无头模式运行（无浏览器 GUI），或 false 以有头模式运行（需要 GUI 设置）。默认为 true。
   • (仅限有头模式) DISPLAY、WAYLAND_DISPLAY、XDG_RUNTIME_DIR：在 Linux 环境中用于 GUI 应用程序的环境变量（特别是 WSLg）。已提供默认值。
   • (仅限有头模式) X11_HOST_PATH、WSLG_HOST_PATH：X11 和 WSLg 套接字/目录的主机路径。已提供默认值。若系统配置不同，请进行调整。对于 Windows Docker 访问 WSL 路径，使用 \\wsl.localhost\DistroName\... 格式（参见 .env.sample）。

运行服务器

1. 构建并启动容器

   docker-compose up --build -d
   

   --build 标志仅在首次运行或 Dockerfile 更改时需要。-d 标志用于以分离模式运行容器（后台运行）。
2. 配置 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 down

✨ 主要特性

• 提供 Docker Compose 环境，方便快捷地设置和管理 Playwright MCP 服务器。
• 支持无头和有头两种运行模式，可根据不同场景灵活切换。

📦 安装指南

按照上述“设置”和“运行服务器”的步骤操作，即可完成 Playwright MCP 服务器的安装与启动。

💻 使用示例

基础用法

# 克隆仓库
git clone <repository-url>
cd playwright-mcp-docker

# 创建.env文件
cp .env.sample .env

# 配置.env文件（可根据需求调整）

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

# 配置MCP客户端（以示例JSON配置为例）
```json
{
    "mcpServers": {
        "playwright_sse": {
            "url": "http://localhost:8931/sse"
        }
    }
}

高级用法

切换模式

• 无头模式：在 .env 文件中设置 HEADLESS=true，适合自动化任务。
• 有头模式：在 .env 文件中设置 HEADLESS=false，适合需要可视化界面的场景。

📚 详细文档

其他信息

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

注意事项

⚠️ 重要提示

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

⚠️ 重要提示

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

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