跳转到内容

MCP 端点 ​

描述 ​

提供 Model Context Protocol(MCP)Streamable HTTP 服务,供 AI 客户端连接并调用浏览器管理工具。需专业版且本地 API 服务已启动。

请求 URL ​

http://localhost:{port}/mcp

{port} 以客户端 API 菜单显示为准。

协议说明 ​

  • 初始化:POST /mcp(initialize 请求)
  • 会话复用:请求头携带 mcp-session-id
  • 通知流:GET /mcp(SSE)
  • 结束会话:DELETE /mcp

具体报文格式遵循 MCP 规范,建议使用官方 SDK 或 Cursor 等已集成客户端连接。

可用工具(摘要) ​

工具名说明
getBrowserList获取环境列表
launchBrowser启动环境,参数 id
stopBrowser关闭环境,参数 id

启动成功后可能附加 Playwright MCP 相关工具,用于页面级自动化。

自定义工具参数与返回 ​

工具arguments返回内容
getBrowserList空对象 {};Schema 不允许额外参数content 文本中的 JSON 对象含 users 数组;每项包含 id、name、createdAt、group、remark 等字段,未定义的字段可能缺失
launchBrowser{"id": 1};id 为 1~9007199254740991 的安全正整数content 文本为启动结果的 JSON;成功时从结果的 data.debuggingPort 获取端口
stopBrowser{"id": 1};id 为安全正整数content 文本为关闭结果的 JSON

以上三个工具的 Schema 均为 additionalProperties: false。工具执行失败时可返回 isError: true;content 中的 text 是字符串,包含对象时需再解析 JSON,不能当作 REST 响应直接读取。启动内核成功但 MCP 连接失败时,也会返回工具错误;应先检查环境是否已运行,避免重复启动。

认证 ​

MCP 与 REST API 共用同一本地服务和鉴权入口。初始化及后续 MCP 请求也必须携带客户端 API 页面中的密钥:

http
api-key: <客户端 API 菜单中的密钥>

mcp-session-id 用于复用会话,不能替代 api-key。MCP 会话建立方式以所用客户端文档为准。

相关文档 ​

工具发现与会话绑定 ​

初始化后通过 tools/list 获取当前版本实际可用的工具及参数 Schema;除三个自定义环境工具外,客户端从内置 Playwright MCP 加载页面工具(如 browser_navigate、browser_snapshot、browser_click)。具体列表取决于客户端打包的 Playwright 版本,不应硬编码工具集合。

在同一 MCP 会话先调用 launchBrowser 并传环境 id,再调用页面工具。未显式绑定时,客户端可能选择第一个可用的已运行环境;多个环境并发时不要依赖这个回退。调用 stopBrowser 或结束会话后,对应连接会清理。各请求都要带 api-key,不要公开请求头、mcp-session-id、页面内容或账号数据。