playwright-mcp-dev 是 Microsoft Playwright 项目中的一份开发技能文档,主要说明如何为 Playwright 添加和调试 MCP 工具以及 CLI 命令。
用途 该技能面向需要扩展或维护 Playwright MCP 相关功能的开发者,提供从新增工具、注册命令到测试与 lint 的完整开发流程指引。
主要能力与操作方式
一、添加 MCP 工具
- 在 packages/playwright/src/mcp/browser/tools/your-tool.ts 中创建新工具。
- 在 packages/playwright/src/mcp/browser/tools.ts 中注册该工具。
- 在 packages/playwright/src/mcp/config.d.ts 中添加 ToolCapability。
- 将新测试放在 tests/mcp/mcp-<category>.spec.ts 中。
二、构建 假定 watch 始终在运行,运行 lint 以查看类型错误。
三、测试 运行测试使用 npm run ctest-mcp <category>。不要运行 test --debug。
四、CLI 命令 CLI 命令基于 MCP 工具。如有需要,先按上述“添加 MCP 工具”部分实现对应的 MCP 工具。 如需为工具添加新的 CLI 类别:
- 在 packages/playwright/src/mcp/terminal/command.ts 中添加 Category。
- 更新文档生成器 packages/playwright/src/mcp/terminal/helpGenerator.ts。
- 在 packages/playwright/src/mcp/terminal/commands.ts 中注册命令。
- 如有必要,更新 packages/playwright/src/skill/SKILL.md 中的技能文件以及 packages/playwright/src/skill/references/ 中的引用。
- 将新测试放在 tests/mcp/cli-<category>.spec.ts 中。
五、添加 CLI 选项或配置选项 当需要向配置中添加内容时:
- packages/playwright/src/mcp/program.ts:添加 CLI 选项和文档。
- packages/playwright/src/mcp/config.d.ts:添加并记录该选项。
- packages/playwright/src/mcp/config.ts:如有需要修改 FullConfig,如有需要修改 CLIOptions,并将其添加到 configFromEnv。
六、构建 假定 watch 始终在运行,运行 lint 以查看类型错误。
七、测试 运行测试使用 npm run ctest-mcp cli-<category>。不要运行 test --debug。
八、Lint 提交前运行 npm run flint 对所有内容进行 lint。
九、SKILL 文件 技能文件位于 packages/playwright/src/skill/SKILL.md,包含所有可用 CLI 命令和 MCP 工具的文档。每当添加新命令或工具时都应更新它。随时可以运行 "npm run playwright-cli -- --help" 查看最新可用命令,并用它们更新技能文件。
适用场景 适用于参与 Playwright MCP 工具与 CLI 命令开发的贡献者,帮助其按项目约定完成工具新增、命令注册、配置扩展、测试编写与代码检查。
限制 该资料仅提供开发流程与文件路径指引,未提供具体功能效果、收费、价格、平台支持范围等信息。