Webmcp

🚀 WebMCP - ウェブクライアント向け大型言語モデルサポートツール

WebMCPは、ウェブサイトがクライアント側で大型言語モデル（LLMs）をサポートできるようにする革新的なツールです。npmパッケージを提供することで、フロントエンドでのLLMsの統合と管理を簡素化します。現在はまだ初期段階ですが、強力な機能と可能性を示しています。

🚀 クイックスタート

📦 インストール

WebMCPをインストールするには、次のコマンドを実行します。

npm install webmcp

⚙️ 初期化設定

MCPサーバーを初期化し、以下のコマンドを実行します。

npx webmcp --init

Dockerを使用する場合は、--docker パラメータを追加してください。

🔌 ウェブサイトへの統合ガイド

📜 WebMCPスクリプトの導入

ウェブサイトでMCP機能をサポートするために、WebMCPスクリプトを導入します。

// index.html
<script src="https://cdn.jsdelivr.net/npm/webmcp/dist/webmcp.min.js"></script>

🎛️ ウィジェットの自動表示

WebMCPは、ユーザーがMCPと簡単にやり取りできるコンソールウィジェットを提供しています。

🔧 技術詳細

🌐 核心フロー

1. 初期接続：MCPクライアントは内部トークンを使用してMCPサーバーに接続します。
2. 登録トークンの取得：ユーザーがウェブサイト登録用のトークンを要求して取得します。
3. ウェブサイトの登録：ユーザーがウェブサイトでトークンを入力し、WebSocketサーバーとの接続とセッショントークンの割り当てを完了します。
4. ツールのやり取り：MCPクライアントはサーバーを介してウェブサイトと通信し、ツールの要求を実行して結果を返します。

📶 ネットワークアーキテクチャ

sequenceDiagram
    参与者 用户
    参与者 MCP（MCP 客户端）
    参与者 服务器（MCP 服务器）
    参与者 WS（WebSocket 服务器）
    参与者 Web（网站）

    %% 初始连接
    MCP->>Server: 连接到 /mcp 使用内部令牌

    %% 网站注册令牌
    User->>MCP: 请求注册令牌
    MCP->>Server: 请求注册令牌
    Server-->>MCP: 返回注册令牌
    MCP-->>User: 显示注册令牌

    %% 网站注册
    User->>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: 返回结果

    %% 断开连接
    User->>Web: 请求断开连接
    Web->>WS: 关闭连接

⚠️ セキュリティに関する考慮事項

このプロジェクトはまだ初期段階ですが、セキュリティを非常に重視しています。悪意のある拡張機能やプロンプト注入攻撃を防ぐために、セキュリティの改善提案を積極的に歓迎します。

✨ 主な機能

🪙 トークン生成器

ウェブサイトの登録プロセスに使用されます。

🛠️ MCPツール定義ツール

ツールのスキーマ構築を簡素化します。

特定のツールのJavaScriptコードが必要な場合は、お問い合わせください。

🐳 Dockerサポート

このプロジェクトには、Smitheryデプロイ用に設計されたDockerfileが用意されています。Dockerを使用してWebSocketサーバーを実行する場合は、提供されている docker-compose.yml のサンプルファイルを参照してください。

MCPクライアントの設定に --docker パラメータが含まれ、--mcp と組み合わされている場合、クライアントはWebSocketサーバーがDockerコンテナ内で実行されていると仮定し、コンテナ接続を介して通信します。