使用说明

项目简介

mcp-wecombot-server 是一个基于 Model Context Protocol (MCP) 构建的服务器应用，它充当 LLM 客户端和企业微信群机器人之间的桥梁。通过注册为 MCP 服务器，它能够接收来自 LLM 客户端的指令，并利用企业微信群机器人 API 将各种消息发送到指定的企业微信群。

主要功能点

发送文本消息 (send_text): 向企业微信群发送纯文本消息，支持提及群成员。
发送 Markdown 消息 (send_markdown): 支持 Markdown 格式的消息，丰富消息展示效果。
发送图片消息 (send_image): 发送图片消息，支持 base64 编码的图片数据。
发送图文消息 (send_news): 以图文形式发送新闻消息，包含标题、描述、链接和图片链接。
发送模板卡片消息 (send_template_card): 发送预定义的模板卡片消息，提供更丰富的交互组件。
上传文件 (upload_file): 上传文件到企业微信，获取 Media ID，为后续发送文件消息做准备 (当前工具未直接支持发送文件消息，但 Media ID 可用于其他工具扩展)。

安装步骤

方法一：通过 Smithery 安装 (Claude Desktop 自动安装)

如果你的 LLM 客户端是 Claude Desktop，可以使用 Smithery 命令行工具自动安装：

npx -y @smithery/cli install @gotoolkits/mcp-wecombot-server --client claude-desktop

方法二：手动安装

克隆仓库并构建:

git clone https://github.com/gotoolkits/mcp-wecombot-server.git
cd mcp-wecombot-server && make build

创建软链接 (方便全局访问):

sudo ln -s $PWD/dist/mcp-wecombot-server_xxx_xxxx /usr/local/bin/mcp-wecombot-server

请将 '$PWD/dist/mcp-wecombot-server_xxx_xxxx' 替换为实际构建生成的二进制文件名。

下载预编译版本 (可选): 你也可以直接下载 Release 页面提供的预编译二进制包并解压使用。

服务器配置

MCP 客户端需要配置 MCP 服务器的启动信息才能连接。以下是 'mcpServers' 配置示例，请添加到你的 MCP 客户端的配置文件中（例如 Claude Desktop 的 'config.json'）：

{
  "mcpServers": {
    "mcp-wecombot-server": {
      "command": "mcp-wecombot-server",
      "env": {
        "WECOM_BOT_WEBHOOK_KEY": "YOUR_WECOM_BOT_WEBHOOK_KEY"
        //  请替换为你的企业微信群机器人的 Webhook Key
        //  Webhook Key 获取方式参考：https://developer.work.weixin.qq.com/document/path/91770
      }
    }
  }
}

配置说明:

'"mcp-wecombot-server"': 服务器名称，在 MCP 客户端中用于标识和调用。
'"command": "mcp-wecombot-server"': 启动 MCP 服务器的命令，这里假设 'mcp-wecombot-server' 二进制文件已添加到系统 PATH 环境变量中。如果未添加到 PATH，请使用二进制文件的完整路径。
'"env"': 环境变量配置。
- '"WECOM_BOT_WEBHOOK_KEY"': 必须配置，企业微信群机器人的 Webhook Key，用于 API 鉴权和消息发送。

基本使用方法

配置完成后，在支持 MCP 协议的 LLM 客户端中，你可以通过 Prompt 调用 'mcp-wecombot-server' 提供的工具来发送企业微信消息。

调用示例 (Prompt):

> prompt: 使用 send_text 工具发送文本消息，内容为：这是一条来自 LLM 的测试消息
> prompt: 使用 send_markdown 工具发送 Markdown 消息，内容为：# 这是一个标题 \n **加粗文本**
> prompt: 使用 send_news 工具发送图文消息，标题为：最新资讯，描述为：这是一条测试图文消息，链接为：https://example.com，图片链接为：https://example.com/image.png

更详细的工具调用 Prompt 示例，请参考仓库 README.md 中的 "Samples" 部分。

注意: 使用前请确保已正确配置 'WECOM_BOT_WEBHOOK_KEY' 环境变量，并且企业微信群机器人配置正确。

关键词