Open Web Unlocker MCP 服务端

使用说明

  • 项目简介

    • Open Web Unlocker 提供一个 MCP 服务器模式,用于向 LLM 客户端提供网页抓取、解析、资源访问等上下文服务。服务器核心职责包括:托管资源与数据、注册并执行工具、定义并渲染 Prompt 模板,并通过 JSON-RPC 与客户端通信,支持会话管理与能力声明。
  • 主要功能点

    • MCP 服务端:接收来自 MCP 客户端的 JSON-RPC 请求,返回资源、工具或提示模板等数据的 JSON-RPC 响应。
    • 资源与工具管理:对网页抓取结果、解析结果、可调用工具等进行注册、查询与执行。
    • Prompt 模板定义:集中管理可自定义的提示模板,支持不同的交互模式。
    • 会话与能力声明:服务器端维护会话状态、能力描述,提供可扩展的上下文服务。
    • 多传输协议支持:理论上兼容 Stdio、SSE、WebSocket 等传输模式,确保与不同 LLM 客户端的对接。
  • 安装与运行

    • 先安装运行时环境(仓库通常使用 Bun Node 环境之一),并在项目中构建运行 MCP 服务端。启用 MCP 模式的命令在仓库中提供样例:
      • bunx open-web-unlocker --mcp
    • 该模式将以 MCP 服务端模式启动,等待来自 MCP 客户端的 JSON-RPC 请求。
  • 服务器配置(MCP 客户端需要的配置信息,服务器端无需额外编码)

    • 配置示例(以 JSON 表示,描述服务端信息,便于 MCP 客户端接入)
    • 注意:以下配置用于 MCP 客户端接入服务器端,不是服务端源码的一部分。请以此信息在客户端进行配置。

{ "serverName": "open-web-unlocker", "command": "bunx", "args": ["open-web-unlocker", "--mcp"] }

说明

  • serverName 为 MCP 服务在客户端侧的标识名,应与服务器实际启动名称一致。

  • command 与 args 指定启动 MCP 服务的命令及其参数,客户端在启动后将通过 MCP 协议与该服务交互。

  • 以上配置仅用于 MCP 客户端的接入描述,实际实现依赖仓库提供的 MCP 服务端实现。

  • 基本使用方法

    • 启动 MCP 服务端:在仓库根目录执行 bunx open-web-unlocker --mcp
    • 客户端接入:在客户端(如 Claude Code 等)中将 MCP 服务器配置为上述 serverName/command/args,建立连接后即可通过 MCP 协议向服务器请求资源、调用工具、获取 Prompts 等上下文信息。
    • 客户端通过 JSON-RPC 发送请求,服务器返回标准的 JSON-RPC 响应或通知。
  • 运行与开发提示

    • 确保运行环境支持所选的运行时(Bun 或 Node 等),并按仓库的 CI 及开发脚本进行编译/打包。
    • MCP 服务端的实现细节在仓库的 src/modes/mcp 及相关入口点中,请确保该模块完整、可编译并符合 MCP 协议要求。
  • 其他

    • 如需自定义资源、工具或 Prompts,请在 MCP 服务端实现中注册相应的资源、工具和模板,确保 LLM 客户端在请求时能够正确地访问并执行相应功能。

服务器信息