Loonghao Wecom Bot MCP Server

🚀 企業微信機器人MCP服務器

本項目是一個基於 FastMCP 框架的企業微信機器人 MCP 服務器實現，支持通過 Webhook URL 接入企業微信機器人，具備命令處理、插件擴展等功能，還能自動記錄消息歷史。

🚀 快速開始

本項目基於 FastMCP 框架實現了企業微信機器人 MCP 服務器。以下是快速上手的步驟：

1. 確保你已經安裝了 Python 3.10 或更高版本，並且安裝以下依賴：

pip install fastmcp httpx python-multipart

2. 創建一個新目錄並初始化項目：

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

3. 在 src 目錄下創建一個新的 Python 文件，例如 server.py：

from fastmcp import FastMCP

app = FastMCP()

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

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

4. 在項目根目錄下創建或修改 pyproject.toml 文件，添加以下內容：

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

5. 安裝依賴後，在項目根目錄下運行：

poetry install
poetry run python src/server.py

默認情況下，服務器將在 :8000 端口啟動。

✨ 主要特性

• 企業微信機器人對接：支持通過 Webhook URL 方式接入企業微信機器人。
• 命令處理：提供基礎的命令處理能力，支持自定義命令擴展。
• 插件系統：基於 FastMCP 的插件架構，方便擴展功能。
• 消息歷史記錄：自動記錄所有收到的消息，默認存儲在內存中。

📦 安裝指南

環境要求

確保你已經安裝了 Python 3.10 或更高版本，並且安裝以下依賴：

pip install fastmcp httpx python-multipart

項目初始化

創建一個新目錄並初始化項目：

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

配置項目文件

在 src 目錄下創建一個新的 Python 文件，例如 server.py：

from fastmcp import FastMCP

app = FastMCP()

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

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

在項目根目錄下創建或修改 pyproject.toml 文件，添加以下內容：

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

運行服務器

安裝依賴後，在項目根目錄下運行：

poetry install
poetry run python src/server.py

默認情況下，服務器將在 :8000 端口啟動。

💻 使用示例

基礎用法

以下是一個簡單的示例，展示瞭如何創建一個處理 ping 命令的服務器：

from fastmcp import FastMCP

app = FastMCP()

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

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

高級用法

你可以根據需求擴展自定義命令和插件，以實現更復雜的功能。

📚 詳細文檔

環境變量配置

設置以下環境變量以啟用企業微信機器人功能：

# Windows PowerShell
$env:WECOM_WEBHOOK_URL="你的企業微信機器人 Webhook URL"

# Linux/macOS
export WECOM_WEBHOOK_URL="你的企業微信機器人 Webhook URL"

基本命令

• ping：返回 "pong"。
• 其他自定義命令：根據插件擴展。

消息歷史記錄

所有消息默認存儲在內存中，可以通過調用 get_message_history() 方法獲取。

在 Cline 中配置

添加以下配置到你的 VSCode 設置文件（cline_mcp_settings.json）：

{
  "mcpServers": {
    "wecom-bot-server": {
      "command": "poetry run python src/server.py",
      "args": [],
      "env": {
        "WECOM_WEBHOOK_URL": "<你的企業微信機器人Webhook URL>"
      },
      "alwaysAllow": [
        "ping"
      ],
      "disabled": false
    }
  }
}

🔧 技術細節

開發流程

克隆倉庫

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

安裝依賴

poetry install --with dev

運行測試

poetry run pytest tests/ --cov=wecom_bot_mcp_server

代碼檢查

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

項目依賴

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

📄 許可證

本項目遵循 MIT License 協議。

貢獻

歡迎提交 Issue 和 Pull Request！