Webmcp

🚀 WebMCP Project Introduction

WebMCP is an open - source project designed to connect Large Language Models (LLMs) and websites. Through WebMCP, websites can register their own functions as tools and interact with the MCP client via the WebSocket protocol. The MCP client can uniformly manage and invoke these tools, allowing users to use them through terminals or other interfaces.

🚀 Quick Start (Users)

📦 Installation

# Install the webmcp tool
npm install -g @webmcp/cli

# Start the MCP server
webmcp server

# Or specify Docker deployment
webmcp server --docker

💡 Example Links

• WebMCP Example Website
• Smithery Integration Example

🚀 Quick Start (Website Owners)

To integrate your website into the WebMCP ecosystem, just follow these two steps:

1. Enter the following command in the console to obtain a registration token:

   webmcp token
   

2. Paste the generated token into your website and complete the configuration as instructed in the documentation.

🔧 Technical Details

🧩 Core Components

• MCP Client: Responsible for connecting to the WebSocket server and managing tools.
• WebSocket Server: Serves as a communication bridge between the MCP client and websites.
• Website: Provides specific tool functions and interacts with the server via the WebSocket protocol.

⚙️ Request Flow

sequenceDiagram
    participant User
    participant MCP as MCP Client
    participant Server as MCP Server
    participant WS as WebSocket Server
    participant Web as Website
    
    %% Initial connection
    MCP->>Server: Connect to /mcp using the internal server token
    
    %% Website registration token
    User->>MCP: Request a registration token
    MCP->>Server: Request a registration token
    Server-->>MCP: Return the registration token
    MCP-->>User: Display the registration token
    
    %% Website registration
    User->>Web: Paste the registration token
    Web->>WS: Connect to /register using the token and domain name (registration token is deleted)
    WS-->>Web: Allocate a channel and session token
    Web->>WS: Connect to the specified channel
    
    %% Tool interaction
    MCP->>Server: Request the tool list
    Server->>WS: Forward the request
    WS->>Web: Request tools
    Web-->>WS: Return the tool list
    WS-->>Server: Forward the tool list
    Server-->>MCP: Return the tool list
    
    %% Tool execution
    MCP->>Server: Tool request
    Server->>WS: Forward the request
    WS->>Web: Execute the tool
    Web-->>WS: Return the result
    WS-->>Server: Forward the result
    Server-->>MCP: Return the result
    
    %% Disconnection
    User->>Web: Disconnect
    Web->>WS: Close the connection

⚠️ Security Considerations

This is a very early - stage project. I attach great importance to enhancing security to prevent malicious extensions from performing prompt injection attacks and other actions. If you have any constructive suggestions, please contact me by submitting an issue.

✨ Built - in Tools

• Token Generator: Used to connect to WebMCP websites.
• MCP Tool Definer: Simplifies the process of building tool schemas for MCP.
  • If needed, I can provide JavaScript examples for WebMCP use. Please let me know in subsequent communications.

🐳 Docker Deployment

The project provides a Dockerfile specifically for Smithery deployment.

If you wish to run the WebSocket server using Docker, I've added a sample docker-compose.yml file.

If the --docker parameter is provided when configuring the MCP client and used together with --mcp, it will assume that the server is running. In this way, you can containerize the main process (WebSocket server), and your MCP client will connect to your Docker container via WebSocket. Similarly, websites will communicate with your Docker container.