Wecom Bot MCP Server

🚀 企業微信機器人MCP兼容服務器實現

本項目開發了一個支持Model Context Protocol（MCP）的企業微信機器人服務器。該服務器可與主流AI模型交互，還能通過企業微信發送消息、文件和圖片，為企業溝通場景提供了便捷的解決方案。

🚀 快速開始

在使用本服務器前，需要完成初始化配置。在config.py文件中添加以下內容：

BOT_TOKEN = "your_bot_token"
API_HOST = "your_api_host"

以下是發送消息的示例代碼：

from wecom_bot_mcp_server import mcp

# 發送文本消息
await mcp.send_message("這是一條測試信息")

# 發送Markdown格式消息
await mcp.send_message("**重要通知**", msg_type="markdown")

✨ 主要特性

• 💬 支持發送多種類型的消息：文本、Markdown格式、文件和圖片
• 👥 提供@提及功能，支持批量用戶通知
• 📜 內建消息歷史記錄模塊
• 🖼️ 支持本地和遠程圖片傳輸
• 📚 提供完整的API接口

📦 安裝指南

使用pip安裝

pip install wecom-bot-mcp-server

從源碼安裝

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

💻 使用示例

基礎用法

from wecom_bot_mcp_server import mcp

# 發送文本消息
await mcp.send_message("這是一條測試信息")

# 發送Markdown格式消息
await mcp.send_message("**重要通知**", msg_type="markdown")

高級用法

from wecom_bot_mcp_server import mcp
import asyncio

async def main():
    # 發送文本消息並@特定用戶
    await mcp.send_message("請大家注意查看", mentioned_list=["user_id_1", "user_id_2"])

    # 發送文件
    await mcp.send_file("path/to/your/file.pdf")

asyncio.run(main())

📚 詳細文檔

發送文本消息

async def send_message(message: str, *, msg_type: str = "text", mentioned_list: List[str] = None):
    """
    發送文本或Markdown格式的消息

    參數:
        message (str): 消息內容
        msg_type (str, 可選): 消息類型，支持"text"和"markdown"
        mentioned_list (List[str], 可選): 需要@提及的用戶ID列表
    返回:
        bool: 發送結果
    """

發送文件

async def send_file(file_path: str):
    """
    上傳併發送文件

    參數:
        file_path (str): 文件路徑，支持本地和遠程URL
    返回:
        bool: 發送結果
    """

🔧 技術細節

環境搭建

1. 安裝依賴：

pip install -r requirements.txt

2. 啟動開發服務器：

python src/server.py

測試流程

1. 運行單元測試：

pytest tests/

2. 執行代碼檢查：

flake8 . --ignore=E501

項目結構

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

📄 許可證

本項目遵循MIT開源協議，詳細內容請參閱LICENSE文件。

📞 聯繫方式

• 作者：longhao
• 郵箱：hal.long@outlook.com