Webmcp

🚀 WebMCP 項目介紹

WebMCP 是一個開源項目，致力於連接大語言模型 (LLM) 和網站。藉助 WebMCP，網站能將自身功能註冊為工具，通過 WebSocket 協議與 MCP 客戶端交互。MCP 客戶端可統一管理和調用這些工具，用戶能通過終端或其他界面使用。

🚀 快速開始

📦 安裝指南

對於用戶而言，可按如下步驟進行安裝：

# 安裝 webmcp 工具
npm install -g @webmcp/cli

# 啟動 MCP 服務端
webmcp server

# 或者指定 Docker 部署
webmcp server --docker

🔗 示例鏈接

• WebMCP 示例網站
• Smithery 集成示例

🌐 網站所有者集成步驟

若您是網站所有者，要將網站集成到 WebMCP 生態，僅需兩步：

1. 在控制檯中輸入以下命令以獲取註冊令牌：

   webmcp token
   

2. 將生成的令牌粘貼到您的網站，並按照 文檔 中的說明完成配置。

✨ 主要特性

🔧 核心組件

• MCP 客戶端：負責連接 WebSocket 服務器並管理工具。
• WebSocket 服務器：作為 MCP 客戶端與網站之間的通信橋樑。
• 網站：提供具體的工具功能，並通過 WebSocket 協議與服務器交互。

🔄 請求流程

sequenceDiagram
    participant 用戶
    participant MCP 作為 MCP 客戶端
    participant Server 作為 MCP 服務器
    participant WS 作為 WebSocket 服務器
    participant Web 作為 網站
    
    %% 初始連接
    MCP->>Server: 連接到 /mcp 使用內部服務器令牌
    
    %% 網站註冊令牌
    用戶->>MCP: 請求註冊令牌
    MCP->>Server: 請求註冊令牌
    Server-->>MCP: 返回註冊令牌
    MCP-->>用戶: 顯示註冊令牌
    
    %% 網站註冊
    用戶->>Web: 粘貼註冊令牌
    Web->>WS: 連接到 /register 使用令牌和域名 (註冊令牌被刪除)
    WS-->>Web: 分配通道和會話令牌
    Web->>WS: 連接至指定通道
    
    %% 工具交互
    MCP->>Server: 請求工具列表
    Server->>WS: 轉發請求
    WS->>Web: 請求工具
    Web-->>WS: 返回工具列表
    WS-->>Server: 轉發工具列表
    Server-->>MCP: 返回工具列表
    
    %% 工具執行
    MCP->>Server: 工具請求
    Server->>WS: 轉發請求
    WS->>Web: 執行工具
    Web-->>WS: 返回結果
    WS-->>Server: 轉發結果
    Server-->>MCP: 返回結果
    
    %% 斷開連接
    用戶->>Web: 斷開連接
    Web->>WS: 關閉連接

⚠️ 安全考量

本項目尚處於非常早期的階段。開發者十分重視加強安全性，以防止惡意擴展執行提示注入攻擊等行為。若您有任何建設性的意見，請通過提交問題或打開一個議題與開發者聯繫。

🛠️ 內置工具

• 令牌生成器：用於連接到 WebMCP 網站。
• MCP 工具定義器：簡化構建 MCP 使用的工具 schema 的過程。
  • 若有需要，開發者可提供針對 WebMCP 使用的 JavaScript 示例，您可在後續信息中告知。

🐳 Docker 部署

項目中提供了專門用於 Smithery 部署的 Dockerfile。若您希望使用 Docker 運行 WebSocket 服務器，項目中添加了一個示範用的 docker-compose.yml 文件。

若 MCP 客戶端配置時提供 --docker 參數，並與 --mcp 一起使用，它將假設服務器正在運行。這樣您可以 Docker 化主進程（WebSocket 服務器），並且您的 MCP 客戶端將通過 WebSocket 連接到您的 Docker 容器。類似地，網站將與您的 Docker 容器通信。