🚀 Playwright SSE MCP 服务器的使用说明
本项目提供了 Playwright SSE MCP 服务器的使用方法，涵盖了安装、配置、高级功能等方面的详细信息，帮助用户快速上手并高效使用该服务器。
🚀 快速开始
安装与运行
- 克隆或下载项目仓库：
git clone https://github.com/torohash/playwright-sse-mcp-server.git /path/to/installation
cd /path/to/installation
- 执行安装脚本：
chmod +x scripts/install.sh
./scripts/install.sh
- 启动服务器：
playwright-mcp-start
默认情况下，服务器将绑定到 0.0.0.0:3002 并在后台运行。若要停止服务，可执行：
playwright-mcp-stop
项目结构
scripts/：包含用于启动、停止和管理服务器的脚本。config/：存放服务器配置文件。
✨ 主要特性
- 支持以无头模式运行 Playwright。
- 使用 SSE（Server-Sent Events）协议与 MCP 客户端通信。
- 可配置持久化运行和自定义重启策略。
📦 安装指南
克隆仓库
git clone https://github.com/torohash/playwright-sse-mcp-server.git /path/to/installation
cd /path/to/installation
执行安装脚本
chmod +x scripts/install.sh
./scripts/install.sh
启动服务器
默认情况下，服务器在端口 3002 绑定并后台运行：
playwright-mcp-start
要停止服务，请执行：
playwright-mcp-stop
📚 详细文档
配置说明
默认配置
默认情况下，服务器使用以下配置：
{
"port": 3002,
"restart_policy": "no",
"persistent": false
}
自定义配置
如需修改配置，可以编辑 config/server.json 文件。
配置文件路径
- 默认配置：
config/default.json - 自定义配置：
config/server.json
环境变量
通过设置以下环境变量可以进一步定制行为：
export PORT=3002
export RESTART_POLICY=no
export PERSISTENT=false
💻 使用示例
基础用法
启动服务器
playwright-mcp-start
停止服务器
playwright-mcp-stop
高级用法
持久化运行
为了使服务器在系统重启后自动启动，使用以下命令：
playwright-mcp-start -p
或者指定端口并启用持久化模式：
playwright-mcp-start --port 4000 --persistent
自定义重启策略
你可以指定不同的重启策略：
playwright-mcp-start -r always
# 或者
playwright-mcp-start --restart always
自定义端口
指定自定义端口启动服务器：
playwright-mcp-start -P 4000
# 或者
playwright-mcp-start --port 4000
🔧 技术细节
该服务器以无头模式运行 Playwright，使用 SSE（Server-Sent Events）协议与 MCP 客户端通信，为用户提供了稳定且高效的服务。
📄 便利的使用方法
为了方便，项目提供了一个启动脚本，可以将其添加到你的 shell 配置文件中。
- 打开你的 shell 配置文件（例如
.bashrc或.zshrc）：
vim ~/.bashrc
- 添加以下内容：
# Playwright MCP Server
export PLAYWRIGHT_MCP_HOME="/path/to/installation"
source "$PLAYWRIGHT_MCP_HOME/scripts/playwright-mcp.sh"
- 保存并退出，然后重新加载配置文件：
source ~/.bashrc
现在你可以在任何位置使用以下命令：
playwright-mcp-start：启动服务器（默认端口 3002）playwright-mcp-stop：停止服务器playwright-mcp-logs：查看日志
⚠️ 重要提示
- 该服务器以无头模式运行 Playwright。
- 服务器使用 SSE（Server-Sent Events）协议与 MCP 客户端通信。
💡 使用建议
如果需要查看命令的帮助信息，可以执行：
playwright-mcp-start --help