loonghao_wecom-bot-mcp-server

🚀 企业微信机器人MCP服务器

本项目是一个基于 FastMCP 框架的企业微信机器人 MCP 服务器实现，支持通过 Webhook URL 接入企业微信机器人，具备命令处理、插件扩展等功能，还能自动记录消息历史。

🚀 快速开始

本项目基于 FastMCP 框架实现了企业微信机器人 MCP 服务器。以下是快速搭建并运行该服务器的步骤：

环境要求

确保你已经安装了 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 端口启动。

✨ 主要特性

• 企业微信机器人对接：支持通过 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

配置项目文件

在项目根目录下的 pyproject.toml 文件中添加以下内容：

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

💻 使用示例

基础用法

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！