wechat-official-account-mcp

v2.0.0

Published

14 days ago

微信公众号 MCP 服务 - 为 AI 应用提供完整的微信公众号 API 集成（15个工具模块）

0High
0Medium
0Low

xwang152

wechat mcp ai api typescript official-account

微信公众号 MCP 服务

一个为 AI 应用提供微信公众号 API 集成的 MCP (Model Context Protocol) 服务项目。

作者: xwang152-jack [email protected] 更新日期: 2025年02月16日

🚀 项目概述

本项目基于 MCP 协议，为 AI 应用（如 Claude Desktop、Cursor、Trae AI 等）提供完整的微信公众号 API 集成。通过标准化的工具接口，AI 应用可以轻松管理微信公众号的用户、标签、菜单、素材、草稿、发布、消息、数据统计等所有核心功能。

当前版本: v2.0.0 （查看 CHANGELOG | v1.1.0 Release Notes）

重大更新: 从 6 个工具扩展到 15 个工具，覆盖微信公众号 95% 的核心 API 功能！（详见功能总览）

📖 文档导航

功能总览 (FEATURES_OVERVIEW.md) - v2.0.0 完整功能介绍、对比表格和使用场景
更新日志 (CHANGELOG.md) - 版本历史和详细更新内容
开发者指南 (CLAUDE.md) - 架构说明、开发规范、常见模式

外部资源

✨ 核心功能

🔐 认证管理: 安全管理微信公众号 AppID、AppSecret 和 Access Token
📁 素材管理: 上传、获取、管理临时和永久素材
📝 草稿管理: 创建、编辑、管理图文草稿
📢 发布管理: 发布草稿到微信公众号
💾 本地存储: 使用 SQLite 本地存储配置和数据
🔧 MCP 集成: 完全兼容 MCP 协议标准
🛡️ 安全增强（v1.1.0）: 支持敏感字段加密存储与日志脱敏，跨域来源白名单配置

🛠️ 技术栈

运行时: Node.js 18+
语言: TypeScript
协议: MCP (Model Context Protocol)
数据库: SQLite
HTTP 客户端: Axios
参数验证: Zod
构建工具: Vite

📦 快速开始

方式一：使用 npx（推荐）

直接使用 npx 运行，无需安装：

# 启动 MCP 服务器
npx wechat-official-account-mcp mcp -a <your_app_id> -s <your_app_secret>

# 示例
npx wechat-official-account-mcp mcp -a wx1234567890abcdef -s your_app_secret_here

提示：如使用 SSE 模式，请设置 CORS_ORIGIN 为允许访问的域名白名单。

方式二：全局安装

# 全局安装
npm install -g wechat-official-account-mcp

# 启动服务
wechat-mcp mcp -a <your_app_id> -s <your_app_secret>

方式三：本地开发

# 1. 克隆项目
git clone https://github.com/xwang152-jack/wechat-official-account-mcp.git
cd wechat-official-account-mcp

# 2. 安装依赖
npm install

# 3. 构建项目
npm run build

# 4. 启动服务
node dist/src/cli.js mcp -a <your_app_id> -s <your_app_secret>

CLI 参数说明

-a, --app-id <appId>: 微信公众号 AppID（必需）
-s, --app-secret <appSecret>: 微信公众号 AppSecret（必需）
-m, --mode <mode>: 传输模式，支持 stdio（默认）和 sse
-p, --port <port>: SSE 模式下的端口号（默认 3000）
-h, --help: 显示帮助信息

环境变量（常用）：

CORS_ORIGIN: 逗号分隔的跨域来源白名单（示例：https://a.example.com,https://b.example.com）
WECHAT_MCP_SECRET_KEY: 开启敏感字段加密存储（AES），设置即启用

🔧 MCP 工具列表

1. 认证工具 (`wechat_auth`)

管理微信公众号认证配置和 Access Token。

支持操作:

configure: 配置 AppID 和 AppSecret
get_token: 获取当前 Access Token
refresh_token: 刷新 Access Token
get_config: 查看当前配置

2. 素材上传工具 (`wechat_media_upload`)

上传和管理微信公众号临时素材。

支持操作:

upload: 上传素材（图片、语音、视频、缩略图）
get: 获取素材信息
list: 暂不支持（临时素材有效期 3 天，建议使用永久素材功能）

支持格式:

图片：JPG、PNG（大小不超过 10MB）
语音：MP3、WMA、WAV、AMR（大小不超过 10MB，时长不超过 60s）
视频：MP4（大小不超过 10MB）
缩略图：JPG（大小不超过 64KB）

3. 图文消息图片上传工具 (`wechat_upload_img`)

上传图文消息内所需的图片，不占用素材库限制。

支持操作:

upload: 上传图片（支持文件路径或base64数据）

支持格式:

图片：JPG、PNG（大小不超过 1MB）

特点:

不占用公众号素材库的100000个图片限制
专用于图文消息内容中的图片
返回可直接在图文消息中使用的图片URL

4. 永久素材工具 (`wechat_permanent_media`)

管理微信公众号永久素材。

支持操作:

add: 上传永久素材（图片、语音、视频、缩略图）
get: 获取永久素材
delete: 删除永久素材
list: 获取素材列表
count: 获取素材总数统计

5. 草稿管理工具 (`wechat_draft`)

管理微信公众号图文草稿。

支持操作:

add: 新建草稿
get: 获取草稿详情
delete: 删除草稿
list: 获取草稿列表
count: 获取草稿总数

6. 发布工具 (`wechat_publish`)

管理微信公众号文章发布。

支持操作:

submit: 发布草稿
get: 获取发布状态
delete: 删除发布
list: 获取发布列表

7. 用户管理工具 (`wechat_user`)

管理微信公众号用户信息和数据统计。

支持操作:

get_user_list: 获取用户列表（支持分页）
get_user_info: 获取用户基本信息
batch_get_user_info: 批量获取用户信息（最多100个）
set_remark: 设置用户备注名
get_user_summary: 获取用户增减数据
get_user_cumulate: 获取累计用户数据

使用场景:

用户画像分析
用户增长追踪
用户信息管理

8. 标签管理工具 (`wechat_tag`)

管理用户标签，实现用户分组。

支持操作:

create: 创建新标签
get_list: 获取所有标签
update: 编辑标签名称
delete: 删除标签
batch_tagging: 批量为用户打标签
batch_untagging: 批量为用户取消标签
get_tag_users: 获取标签下的用户列表

使用场景:

用户分组管理
精准营销
用户分层运营

9. 自定义菜单工具 (`wechat_menu`)

管理公众号底部菜单。

支持操作:

create: 创建自定义菜单
get: 查询当前菜单
delete: 删除菜单
add_conditional: 创建个性化菜单
delete_conditional: 删除个性化菜单
get_selfmenu_info: 获取菜单配置

菜单类型:

click: 点击推事件
view: 跳转URL
scancode_push: 扫码推事件
pic_photo_or_album: 拍照或相册发图
location_select: 发送位置

使用场景:

功能导航
活动推广
自定义服务入口

10. 模板消息工具 (`wechat_template_msg`)

发送服务通知类模板消息。

支持操作:

send: 发送模板消息
get_all_templates: 获取所有模板
delete: 删除模板
get_industry: 获取账号所属行业

使用场景:

订单通知
支付成功通知
预约提醒
物流更新

注意: 模板消息需要先在微信公众平台后台配置模板。

11. 客服消息工具 (`wechat_customer_service`)

在用户动作后48小时内主动发送消息。

支持操作:

send_text: 发送文本消息
send_image: 发送图片消息
send_voice: 发送语音消息
send_video: 发送视频消息
send_music: 发送音乐消息
send_news: 发送图文消息
send_mpnews: 发送永久图文素材
get_records: 获取客服聊天记录

使用场景:

用户咨询回复
售后服务
主动关怀

限制: 只能在用户产生动作后48小时内发送。

12. 数据统计分析工具 (`wechat_statistics`)

获取公众号运营数据分析。

支持操作:

get_article_summary: 图文群发每日数据
get_article_total: 图文群发总数据
get_user_read: 图文统计数据
get_user_share: 图文分享转发数据
get_upstream_message: 消息发送概况
get_interface_summary: 接口分析数据
get_interface_summary_hour: 接口分时数据

数据维度:

用户分析
图文分析
消息分析
接口分析

使用场景:

运营数据分析
内容效果评估
接口性能监控

13. 自动回复工具 (`wechat_auto_reply`)

查询自动回复规则配置。

支持操作:

get_current_info: 获取当前自动回复规则

包含信息:

关注后自动回复
消息自动回复
关键词自动回复

使用场景:

查看当前配置
调试自动回复规则

14. 群发消息工具 (`wechat_mass_send`)

向用户群发消息。

支持操作:

send_by_tag: 根据标签群发
send_by_openid: 根据OpenID列表群发
delete: 删除群发
preview: 预览群发消息

支持消息类型:

mpnews: 图文消息
text: 文本消息
voice: 语音消息
image: 图片消息
mpvideo: 视频消息
wxcard: 卡券消息

限制说明:

订阅号：每天只能群发1条
服务号：每月可群发4条
群发给全部用户需要管理员二次确认

使用场景:

内容推送
活动通知
节日问候

15. 订阅通知工具 (`wechat_subscribe_msg`)

发送一次性订阅通知。

支持操作:

send: 发送订阅通知

特点:

需要用户主动订阅
一次性推送
可包含小程序跳转

使用场景:

服务进度通知
预约成功通知
重要事件提醒

注意: 订阅通知是模板消息的升级版，需要用户授权。

📁 项目结构

src/
├── cli.ts               # CLI 入口文件
├── index.ts             # 模块导出入口
├── mcp-server/          # MCP 服务器实现
│   ├── shared/          # 共享组件
│   │   ├── init.ts      # 服务器初始化
│   │   └── types.ts     # 类型定义
│   └── transport/       # 传输层实现
│       ├── stdio.ts     # stdio 传输
│       └── sse.ts       # SSE 传输
├── mcp-tool/            # MCP 工具实现
│   ├── index.ts         # 工具管理器
│   ├── types.ts         # 类型定义
│   └── tools/           # 具体工具实现
│       ├── index.ts
│       ├── auth-tool.ts
│       ├── media-upload-tool.ts
│       ├── upload-img-tool.ts
│       ├── permanent-media-tool.ts
│       ├── draft-tool.ts
│       └── publish-tool.ts
├── auth/                # 认证管理
│   └── auth-manager.ts
├── wechat/              # 微信 API 客户端
│   └── api-client.ts
├── storage/             # 数据存储
│   └── storage-manager.ts
└── utils/               # 工具函数
    ├── logger.ts
    └── db-init.ts

🔗 在 AI 应用中使用

Claude Desktop

在 claude_desktop_config.json 中添加：

{
  "mcpServers": {
    "wechat-official-account": {
      "command": "npx",
      "args": [
        "wechat-official-account-mcp",
        "mcp",
        "-a", "your_wechat_app_id",
        "-s", "your_wechat_app_secret"
      ]
    }
  }
}

或者使用全局安装的版本：

{
  "mcpServers": {
    "wechat-official-account": {
      "command": "wechat-mcp",
      "args": [
        "mcp",
        "-a", "your_wechat_app_id",
        "-s", "your_wechat_app_secret"
      ]
    }
  }
}

Cursor / Trae AI

在 MCP 配置中添加服务器配置：

{
  "mcpServers": {
    "wechat-official-account": {
      "command": "npx",
      "args": [
        "wechat-official-account-mcp",
        "mcp",
        "-a", "your_wechat_app_id",
        "-s", "your_wechat_app_secret"
      ]
    }
  }
}

或者使用全局安装的版本：

{
  "mcpServers": {
    "wechat-official-account": {
      "command": "wechat-mcp",
      "args": [
        "mcp",
        "-a", "your_wechat_app_id",
        "-s", "your_wechat_app_secret"
      ]
    }
  }
}

🧪 开发指南

开发模式

# 安装依赖
npm install

# 构建项目
npm run build

# 本地测试 CLI
node dist/src/cli.js mcp -a test_app_id -s test_app_secret

# 类型检查
npm run check

# 代码检查
npm run lint

构建和发布

# 构建项目
npm run build

# 本地测试包
npm pack

# 发布到 npm
npm publish

测试

# 运行测试
npm test

# 测试 CLI 功能
node dist/src/cli.js --help

📝 配置说明

环境变量

创建 .env 文件：

# 开发模式（可选）
NODE_ENV=development

# 调试模式（可选）
DEBUG=true

# 跨域来源白名单（强烈建议生产环境设置）
CORS_ORIGIN=https://your-domain.com,https://another-domain.com

# 开启敏感字段加密（设置后启用 AES 加密存储）
WECHAT_MCP_SECRET_KEY=your-strong-secret-key

# 数据库路径（可选，默认为 ./data/wechat-mcp.db）
DB_PATH=./data/wechat-mcp.db

微信公众号配置

登录微信公众平台
进入「开发」->「基本配置」
获取 AppID 和 AppSecret
使用 wechat_auth 工具进行配置

🔒 安全说明

加密存储：设置 WECHAT_MCP_SECRET_KEY 后，app_secret/token/encoding_aes_key/access_token 以加密形式持久化（带 enc: 前缀标识）
日志脱敏：错误日志仅记录状态码或消息，避免泄露响应体与敏感信息
跨域白名单：生产环境务必设置 CORS_ORIGIN 为精确域名列表，避免 *
参数校验：工具参数使用 Zod 校验，降低不当输入风险
切勿提交密钥：不要将 AppSecret、Token 等放入代码仓库或构建产物

🤝 贡献指南

Fork 本项目
创建特性分支 (git checkout -b feature/AmazingFeature)
提交更改 (git commit -m 'Add some AmazingFeature')
推送到分支 (git push origin feature/AmazingFeature)
开启 Pull Request

📄 许可证

本项目采用 MIT 许可证。详见 LICENSE 文件。

🆘 支持

如果您遇到问题或有建议，请：

查看 Issues 页面
创建新的 Issue
联系项目维护者: xwang152-jack [email protected]

🙏 致谢

Model Context Protocol - MCP 协议标准
微信公众平台 - 微信公众号 API
Anthropic - Claude Desktop MCP 支持

注意: 本项目仅供学习和开发使用，请遵守微信公众平台的使用条款和相关法律法规。

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

微信公众号 MCP 服务

🚀 项目概述

📖 文档导航

外部资源

✨ 核心功能

🛠️ 技术栈

📦 快速开始

方式一：使用 npx（推荐）

方式二：全局安装

方式三：本地开发

CLI 参数说明

🔧 MCP 工具列表

1. 认证工具 (wechat_auth)

2. 素材上传工具 (wechat_media_upload)

3. 图文消息图片上传工具 (wechat_upload_img)

4. 永久素材工具 (wechat_permanent_media)

5. 草稿管理工具 (wechat_draft)

6. 发布工具 (wechat_publish)

7. 用户管理工具 (wechat_user)

8. 标签管理工具 (wechat_tag)

9. 自定义菜单工具 (wechat_menu)

10. 模板消息工具 (wechat_template_msg)

11. 客服消息工具 (wechat_customer_service)

12. 数据统计分析工具 (wechat_statistics)

13. 自动回复工具 (wechat_auto_reply)

14. 群发消息工具 (wechat_mass_send)

15. 订阅通知工具 (wechat_subscribe_msg)

📁 项目结构

🔗 在 AI 应用中使用

Claude Desktop

Cursor / Trae AI

🧪 开发指南

开发模式

构建和发布

测试

📝 配置说明

环境变量

微信公众号配置

🔒 安全说明

🤝 贡献指南

📄 许可证

🆘 支持

🙏 致谢

1. 认证工具 (`wechat_auth`)

2. 素材上传工具 (`wechat_media_upload`)

3. 图文消息图片上传工具 (`wechat_upload_img`)

4. 永久素材工具 (`wechat_permanent_media`)

5. 草稿管理工具 (`wechat_draft`)

6. 发布工具 (`wechat_publish`)

7. 用户管理工具 (`wechat_user`)

8. 标签管理工具 (`wechat_tag`)

9. 自定义菜单工具 (`wechat_menu`)

10. 模板消息工具 (`wechat_template_msg`)

11. 客服消息工具 (`wechat_customer_service`)

12. 数据统计分析工具 (`wechat_statistics`)

13. 自动回复工具 (`wechat_auto_reply`)

14. 群发消息工具 (`wechat_mass_send`)

15. 订阅通知工具 (`wechat_subscribe_msg`)