Loonghao Wecom Bot MCP Server

🚀 WeCom Bot MCP Server

A WeCom bot MCP server implementation based on the FastMCP framework.

✨ Features

• WeCom Bot Integration: Supports connecting to WeCom bots via Webhook URL.
• Command Handling: Provides basic command handling capabilities and supports custom command extensions.
• Plugin System: Based on the FastMCP plugin architecture, it's easy to extend functionality.
• Message History: Automatically records all received messages, stored in memory by default.

📦 Installation

1. Environment Requirements

Ensure you have Python 3.10 or higher installed, and install the following dependencies:

pip install fastmcp httpx python-multipart

2. Quick Start

Create a new directory and initialize the project:

poetry init --no-interaction --name wecom-bot-mcp-server
poetry add fastmcp httpx python-multipart

Create a new Python file, for example, server.py, in the src directory:

from fastmcp import FastMCP

app = FastMCP()

@app.command(name="ping")
async def cmd_ping(ctx, args):
    return "pong"

if __name__ == "__main__":
    app.run()

Create or modify the pyproject.toml file in the project root directory and add the following content:

[build-system]
requires = ["poetry>=1.0"]
dependencies = [
    "fastmcp",
    "httpx",
    "python-multipart"
]

3. Run the Server

After installing the dependencies, run the following commands in the project root directory:

poetry install
poetry run python src/server.py

By default, the server will start on port :8000.

💻 Usage Examples

Environment Variable Configuration

Set the following environment variables to enable the WeCom bot functionality:

# Windows PowerShell
$env:WECOM_WEBHOOK_URL="Your WeCom bot Webhook URL"

# Linux/macOS
export WECOM_WEBHOOK_URL="Your WeCom bot Webhook URL"

Basic Commands

• ping: Returns "pong".
• Other custom commands: Extended according to plugins.

Message History

All messages are stored in memory by default and can be retrieved by calling the get_message_history() method.

Configuration in Cline

1. Add the following configuration to your VSCode settings file (cline_mcp_settings.json):

{
  "mcpServers": {
    "wecom-bot-server": {
      "command": "poetry run python src/server.py",
      "args": [],
      "env": {
        "WECOM_WEBHOOK_URL": "<Your WeCom bot Webhook URL>"
      },
      "alwaysAllow": [
        "ping"
      ],
      "disabled": false
    }
  }
}

🔧 Development

Clone the Repository

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

Install Dependencies

poetry install --with dev

Run Tests

poetry run pytest tests/ --cov=wecom_bot_mcp_server

Code Checks

poetry run ruff check .
poetry run ruff format .
poetry run mypy src/wecom_bot_mcp_server --strict

Project Dependencies

• Python >= 3.10
• FastMCP >= 0.4.1
• httpx >= 0.24.1

📄 License

This project is licensed under the MIT License.

Contribution

Welcome to submit Issues and Pull Requests!