WebMCP 使用说明

项目简介

WebMCP 旨在使网站能够轻松地向客户端大型语言模型（LLM）共享工具、资源和Prompt，从而将网站转变为 MCP 服务器。这使得网站能够在不共享 API 密钥的情况下增强用户体验和 LLM 应用的功能，并支持各种 LLM 模型。

主要功能点

资源管理：网站可以托管和管理资源，供连接的 LLM 客户端访问。
工具注册与执行：网站可以注册工具，允许 LLM 客户端调用这些工具以执行外部功能。
Prompt 模板定义：网站可以定义和提供 Prompt 模板，以实现可定制的 LLM 交互模式。
WebSocket 通信：使用 WebSocket 协议进行 MCP 客户端和服务器之间的实时双向通信。
频道化访问：支持多个网站同时连接，并根据域名对工具进行作用域划分，方便组织管理。
内置工具：包含用于连接 WebMCP 网站的令牌生成器和 MCP 工具定义器。
Docker 支持：提供 Dockerfile 和 docker-compose 文件，方便用户进行容器化部署。

安装步骤

安装 WebMCP：使用 npm 全局安装 WebMCP 包：

npm install -g @jason.today/webmcp

或者，您可以使用仓库 README 中提到的 'npx' 命令：

npx -y @jason.today/webmcp@latest --mcp

启动 WebMCP WebSocket 服务器：运行服务器，使用命令：
```
webmcp
```
此命令将启动 WebSocket 服务器，它充当 MCP 服务器的后端。

服务器配置 (MCP 客户端)

要将 MCP 客户端（例如 Claude、Cursor 等）连接到 WebMCP 服务器，您需要配置客户端以使用 WebMCP 服务器。配置信息为 JSON 格式，需要添加到您的 MCP 客户端的设置中。以下是一个示例配置：

{
  "webmcp": {  // 服务器配置的名称，可以自定义
    "serverName": "WebMCP Server", // 可选：服务器的用户友好名称
    "command": "npx",  // 用于启动 WebMCP 服务器的命令
    "args": [  // 命令的参数
      "-y",
      "@jason.today/webmcp@latest",
      "--mcp"  // 标志，指示 MCP 服务器模式
    ]
  }
}

注意： 'command' 和 'args' 由 MCP 客户端用于在 WebMCP 服务器未运行时启动它。您可能需要根据您的环境以及安装 WebMCP 的方式调整 'command' 和 'args'。如果您单独运行 WebSocket 服务器（例如，使用 'node build/index.js'），则无需在 MCP 客户端中包含此服务器配置。此配置主要适用于管理服务器生命周期的客户端。

基本使用方法

生成连接令牌：在终端中运行 'webmcp --new'。这将生成一个连接令牌。
连接到 WebMCP 启用的网站：打开已集成 WebMCP 的网站（例如 webmcp.dev）。点击 WebMCP 小部件（通常是一个小的蓝色方块）。
粘贴令牌：将生成的令牌粘贴到网站 WebMCP 小部件的输入字段中，然后单击“连接”。
使用 MCP 客户端：您的 MCP 客户端（配置了 WebMCP 服务器）现在应该能够访问由连接的网站提供的工具、Prompt 和资源。

关键词