项目简介

'wecom-bot-mcp-server' 是一个基于 FastMCP 框架构建的企业微信机器人 MCP 服务器。它允许 LLM 客户端通过 MCP 协议调用工具发送企业微信消息,并将消息历史作为资源进行管理。该服务器旨在为 LLM 应用提供企业微信消息发送能力,并集成到 MCP 生态系统中。

主要功能点

  • 发送企业微信消息: 通过 'send_message' 工具,LLM 客户端可以调用服务器发送 Markdown 格式的企业微信消息到配置的群聊或个人。
  • 消息历史记录: 服务器维护消息发送历史,并以 'message-history' 资源的形式提供给 LLM 客户端,方便追溯和管理上下文。
  • 基于 FastMCP 框架: 利用 FastMCP 框架的强大功能,提供稳定可靠的 MCP 服务器基础架构,包括 JSON-RPC 通信、会话管理等。
  • 异步消息发送: 支持异步消息发送,提高服务器的并发处理能力。
  • 易于安装和配置: 提供 pip 和 poetry 两种安装方式,配置简单,易于上手。

安装步骤

  1. 安装 'wecom-bot-mcp-server':

    可以使用 pip 或 poetry 进行安装。推荐使用 poetry。

    使用 pip:

    pip install wecom-bot-mcp-server

    使用 poetry:

    poetry add wecom-bot-mcp-server
  2. 设置环境变量 'WECOM_WEBHOOK_URL':

    你需要配置企业微信机器人的 Webhook URL,并将其设置为环境变量 'WECOM_WEBHOOK_URL'。请替换 '<你的企业微信机器人Webhook URL>' 为你实际的 Webhook URL。

    在 Windows PowerShell 中设置:

    $env:WECOM_WEBHOOK_URL="<你的企业微信机器人Webhook URL>"

    在 Linux/macOS 中设置:

    export WECOM_WEBHOOK_URL="<你的企业微信机器人Webhook URL>"

服务器配置 (MCP 客户端配置)

以下是在 MCP 客户端 (例如 Cline) 中配置 'wecom-bot-mcp-server' 的示例配置,请将此配置添加到你的 MCP 客户端的服务器配置文件中。

{
  "mcpServers": {
    "wecom-bot-server": {  // 服务器名称,可以自定义,用于在客户端中引用
      "command": "wecom-bot-mcp-server",  // 启动服务器的命令,通常为安装后可执行的命令名
      "args": [],  // 启动参数,本项目无需额外参数
      "env": {  // 环境变量配置
        "WECOM_WEBHOOK_URL": "<你的企业微信机器人Webhook URL>"  // 企业微信机器人 Webhook URL,请替换为你的实际 URL
      },
      "alwaysAllow": [  // 默认允许的工具列表,客户端可以直接调用,无需用户授权
        "send_message"  // 允许客户端默认调用 send_message 工具
      ],
      "disabled": false  // 是否禁用该服务器,false 表示启用
    }
  }
}

配置说明:

  • 'command': 指定启动 'wecom-bot-mcp-server' 的命令。安装后可以直接使用 'wecom-bot-mcp-server' 命令。
  • 'args': 启动参数,本项目不需要额外的启动参数,所以为空数组 '[]'。
  • 'env': 环境变量配置。'WECOM_WEBHOOK_URL' 必须在此处或系统环境中配置,用于指定企业微信机器人 Webhook 地址。请务必替换 '<你的企业微信机器人Webhook URL>' 为你实际的企业微信机器人 Webhook URL。
  • 'alwaysAllow': 指定默认允许客户端调用的工具。这里配置了 'send_message',意味着客户端可以无需额外授权直接调用 'send_message' 工具发送消息。
  • 'disabled': 设置为 'false' 表示启用该 MCP 服务器。

基本使用方法

  1. 启动 MCP 服务器:

    在安装了 'wecom-bot-mcp-server' 的环境中,直接运行以下命令即可启动服务器:

    wecom-bot-mcp-server

    服务器启动后,会监听 MCP 客户端的请求。

  2. 在 MCP 客户端中使用 'send_message' 工具:

    在 MCP 客户端中 (例如 Cline),配置好上述服务器配置后,即可调用 'wecom-bot-server' 的 'send_message' 工具发送企业微信消息。具体的调用方式取决于 MCP 客户端的接口和使用方式。通常,你需要指定服务器名称 ('wecom-bot-server') 和工具名称 ('send_message'),并提供消息内容作为参数。

  3. 获取消息历史资源:

    MCP 客户端可以通过资源路径 'config://message-history' 获取消息历史。具体的获取方式也取决于 MCP 客户端的接口。

示例 (假设在 Cline 中使用):

在 Cline 中,你可以通过类似以下的命令调用 'send_message' 工具 (具体命令格式请参考 Cline 的文档):

> :tool wecom-bot-server.send_message "你好,企业微信!"

或者获取消息历史资源:

> :resource config://message-history from wecom-bot-server

请参考你的 MCP 客户端的具体文档来了解如何配置和使用 MCP 服务器及其提供的工具和资源。

信息

分类

通信与社交