Metadata-Version: 2.4
Name: mcp_server_wechat
Version: 0.8
Summary: 基于MCP技术的微信聊天记录获取和消息发送功能的服务器
Home-page: https://github.com/panxingfeng/mcp_server_wechat
Download-URL: https://github.com/panxingfeng/mcp_server_wechat/archive/refs/tags/0.7.tar.gz
Author: panxingfeng
Author-email: panxingfeng <1115005803@qq.com>
License: MIT
Project-URL: Homepage, https://github.com/panxingfeng/mcp_server_wechat
Project-URL: Download, https://github.com/panxingfeng/mcp_server_wechat/archive/refs/tags/0.8.tar.gz
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Communications :: Chat
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3.11
Classifier: Natural Language :: Chinese (Simplified)
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pywechat127>=1.8.8
Requires-Dist: mcp==1.9.1
Requires-Dist: pywinauto==0.6.9
Requires-Dist: PyAutoGUI==0.9.54
Requires-Dist: starlette>=0.28.0
Requires-Dist: uvicorn>=0.24.0
Requires-Dist: sse-starlette>=1.6.5
Dynamic: author
Dynamic: download-url
Dynamic: home-page
Dynamic: license-file

# MCP Server WeChat
基于MCP技术的微信聊天记录获取和消息发送功能的服务器，使用[pywechat](https://github.com/Hello-Mr-Crab/pywechat)工具实现微信自动化操作。

## 功能特点
此服务器提供以下主要功能：
- 获取微信聊天记录（指定日期）
- 发送单条消息给单个好友
- 发送多条消息给单个好友 
- 发送消息给多个好友

## 可用工具
- `wechat_get_chat_history` - 获取特定日期的微信聊天记录
  - 必需参数:
    - `to_user` (string): 好友或群聊备注或昵称
    - `target_date` (string): 目标日期，格式为YY/M/D，如25/3/22

- `wechat_send_message` - 向单个微信好友发送单条消息
  - 必需参数:
    - `to_user` (string): 好友或群聊备注或昵称
    - `message` (string): 要发送的消息

- `wechat_send_multiple_messages` - 向单个微信好友发送多条消息
  - 必需参数:
    - `to_user` (string): 好友或群聊备注或昵称
    - `messages` (array): 要发送的消息列表 (用英文逗号分隔的字符串输入)

- `wechat_send_to_multiple_friends` - 向多个微信好友发送单条或者多条消息
  - 必需参数:
    - `to_user` (array): 好友或群聊备注或昵称列表 (用英文逗号分隔的字符串输入)
    - `message` (string/array): 要发送的消息 (单条消息会发给所有好友；多条消息用英文逗号分隔且数量与好友数相同时，将分别发送给对应好友)

## 安装方法

### stdio版

```bash
pip install mcp_server_wechat

获取最新
pip install --upgrade mcp_server_wechat
```
### sse版/Streamable_HTTP版
```bash
python -m venv venv  # 创建虚拟环境
venv/scripts/activate # 激活环境
pip install -r requirements.txt
```

## 使用示例

### 配置为 MCP 服务

在您的 MCP 配置中添加：

stdio版
```json
"mcpServers": {
  "wechat": {
    "command": "python",
    "args": ["-m", "mcp_server_wechat","--folder-path=存放历史记录的目录"]
  }
}
```
sse版

启动命令 
```bash
python -m mcp_server_wechat_sse --folder-path=x:\xxxxx #默认文件夹可以在代码中修改
```
```json
"mcpServers": {
  "wechat": {
    "url": "http://localhost:3000/sse"
  }
}
```
Streamable_HTTP版

启动命令 
```bash
python -m mcp_server_wechat_Streamable_HTTP --folder-path=x:\xxxxx #默认文件夹可以在代码中修改
```
```json
"mcpServers": {
  "wechat": {
    "url": "http://localhost:3000/mcp"
  }
}
```

### 调用示例

1. 获取聊天记录:
```json
{
  "name": "wechat_get_chat_history",
  "arguments": {
    "to_user": "张三",
    "target_date": "25/3/22"
  }
}
```

2. 发送单条消息:
```json
{
  "name": "wechat_send_message",
  "arguments": {
    "to_user": "张三",
    "message": "你好，这是一条测试消息"
  }
}
```

3. 发送多条消息:
```json
{
  "name": "wechat_send_multiple_messages",
  "arguments": {
    "to_user": "张三",
    "messages": "你好","这是第一条消息","这是第二条消息"
  }
}
```

4. 发送给多个好友(单条消息):
```json
{
  "name": "wechat_send_to_multiple_friends",
  "arguments": {
    "to_user": ["张三", "李四", "王五"],
    "message": "大家好，这是一条群发消息"或者"你好，张三","你好，李四","你好，王五"
  }
}
```

## 调试

您可以使用 MCP inspector 来调试服务器:

```bash
npx @modelcontextprotocol/inspector python -m mcp_server_wechat
```

## 实际效果展示

<table>
  <tr>
    <td align="center" width="33%">
      <img src="https://raw.githubusercontent.com/panxingfeng/mcp_server_wechat/main/测试.png" width="330" /><br>
      <em>inspector的测试</em>
    </td>
    <td align="center" width="33%">
      <img src="https://raw.githubusercontent.com/panxingfeng/mcp_server_wechat/main/多工具测试.gif" width="330" /><br>
      <em>基于我自己UI(仿Cherry Studio)</a>的测试</em>
    </td>
    <td align="center" width="34%">
      <img src="https://raw.githubusercontent.com/panxingfeng/mcp_server_wechat/main/Streamable_HTTP_测试.png" width="330" /><br>
      <em>基于 Cherry Studio 的Streamable_HTTP</a>的测试</em> 
    </td>
  </tr>
</table>

## 注意事项

- 使用本工具需要保持微信桌面版处于登录状态
- 获取聊天记录和发送消息需要确保微信窗口能够被正常操作
- 在使用过程中，请勿手动操作微信窗口，以免干扰自动化操作
- 请勿使用此工具进行任何违反微信服务协议的行为

## 许可证

mcp_server_wechat 使用 MIT 许可证。这意味着您可以自由使用、修改和分发此软件，但需遵守 MIT 许可证的条款和条件。详情请参阅项目仓库中的 LICENSE 文件。
