内容
# weflow-mcp
用于调用本地 [WeFlow](https://github.com/hicccc77/WeFlow) HTTP API 的 TypeScript MCP 服务器。
WeFlow 必须在本地运行并启用 **API 服务**。默认 API 基本 URL 为 `http://127.0.0.1:5031`。除健康检查外，WeFlow `/api/v1/*` 端点需要访问令牌。
## 安装
直接使用 `npx`：
```bash
npx -y weflow-mcp
```
或从源代码安装：
```bash
npm install
npm run build
```
## 配置
在 MCP 客户端中设置以下环境变量：
| 变量 | 默认值 | 描述 |
| --- | --- | --- |
| `WEFLOW_BASE_URL` | `http://127.0.0.1:5031` | WeFlow HTTP API 基本 URL |
| `WEFLOW_ACCESS_TOKEN` | 空 | WeFlow API 令牌 |
| `WEFLOW_API_TOKEN` | 空 | 备用令牌名称，如果 `WEFLOW_ACCESS_TOKEN` 为空，则使用 |
| `WEFLOW_TIMEOUT_MS` | `30000` | 请求超时毫秒数 |
## MCP 客户端示例
```json
{
"mcpServers": {
"weflow": {
"command": "node",
"args": ["/home/projects/wechat-tool/weflow-mcp/dist/index.js"],
"env": {
"WEFLOW_BASE_URL": "http://127.0.0.1:5031",
"WEFLOW_ACCESS_TOKEN": "YOUR_TOKEN"
}
}
}
}
```
npm 发布后，可以使用 `npx` 代替：
```json
{
"mcpServers": {
"weflow": {
"command": "npx",
"args": ["-y", "weflow-mcp"],
"env": {
"WEFLOW_BASE_URL": "http://127.0.0.1:5031",
"WEFLOW_ACCESS_TOKEN": "YOUR_TOKEN"
}
}
}
}
```
## 工具
- `weflow_health`: 检查 WeFlow API 健康状态。
- `weflow_list_sessions`: 列出聊天会话。
- `weflow_get_messages`: 从聊天会话中获取消息。
- `weflow_get_session_messages_chatlab`: 以 ChatLab 格式拉取一个会话。
- `weflow_list_contacts`: 列出联系人。
- `weflow_get_group_members`: 列出群组成员。
- `weflow_sns_timeline`: 获取朋友圈时间线。
- `weflow_sns_usernames`: 列出朋友圈发布者。
- `weflow_sns_export_stats`: 获取朋友圈导出统计信息。
- `weflow_sns_export`: 启动朋友圈导出。
- `weflow_sns_block_delete`: 获取/安装/卸载朋友圈防删除状态。
- `weflow_request`: 调用任意支持的 WeFlow API 端点，自定义方法/查询/正文。
## 注意事项
- WeFlow 的 API 默认仅监听 `127.0.0.1`。
- 在使用数据工具之前，请在 WeFlow 应用中将 WeFlow 连接到微信数据库。
- 消息 API 返回的媒体 URL 在调用 `media=1` 的消息后可使用。
