Wecom Bot MCP Server

🚀 WeCom Bot MCP Compatible Server Implementation

We've developed a WeCom bot server that supports the Model Context Protocol (MCP). This server can interact with mainstream AI models and send messages, files, and images via WeCom.

🚀 Quick Start

Initial Configuration

Add the following content to the config.py file:

BOT_TOKEN = "your_bot_token"
API_HOST = "your_api_host"

Sending Message Example

from wecom_bot_mcp_server import mcp

# Send a text message
await mcp.send_message("This is a test message")

# Send a Markdown-formatted message
await mcp.send_message("**Important Notice**", msg_type="markdown")

✨ Features

• Support sending various types of messages: text, Markdown format, files, and images.
• Provide the @mention function, supporting batch user notifications.
• Built-in message history module.
• Support local and remote image transmission.
• Provide a complete API interface.

📦 Installation

Install using pip

pip install wecom-bot-mcp-server

Install from source code

git clone https://github.com/loonghao/wecom-bot-mcp-server.git
cd wecom-bot-mcp-server
pip install -e .

💻 Usage Examples

Basic Usage

from wecom_bot_mcp_server import mcp

# Send a text message
await mcp.send_message("This is a test message")

# Send a Markdown-formatted message
await mcp.send_message("**Important Notice**", msg_type="markdown")

Advanced Usage

from wecom_bot_mcp_server import mcp
import asyncio

async def send_messages():
    # Send a text message with @mention
    await mcp.send_message("This is a test message with @mention", mentioned_list=["user1", "user2"])
    # Send a file
    await mcp.send_file("path/to/your/file")

asyncio.run(send_messages())

📚 Documentation

Sending Text Messages

async def send_message(message: str, *, msg_type: str = "text", mentioned_list: List[str] = None):
    """
    Send a text or Markdown-formatted message
    
    Parameters:
        message (str): Message content
        msg_type (str, optional): Message type, supports "text" and "markdown"
        mentioned_list (List[str], optional): List of user IDs to be @mentioned
    Returns:
        bool: Sending result
    """

Sending Files

async def send_file(file_path: str):
    """
    Upload and send a file
    
    Parameters:
        file_path (str): File path, supports local and remote URLs
    Returns:
        bool: Sending result
    """

🔧 Technical Details

Environment Setup

1. Install dependencies:

pip install -r requirements.txt

2. Start the development server:

python src/server.py

Testing Process

1. Run unit tests:

pytest tests/

2. Perform code inspection:

flake8 . --ignore=E501

Project Structure

wecom-bot-mcp-server/
├── src/
│   └── wecom_bot_mcp_server/
│       ├── __init__.py
│       ├── server.py
│       ├── message_handler.py
│       └── file_storage.py
└── tests/
    └── test_*.py

📄 License

This project follows the MIT open-source license. For detailed information, please refer to the LICENSE file.

📞 Contact Information

• Author: longhao
• Email: hal.long@outlook.com