使用说明
项目简介
WeChat Summarizer MCP服务器 (mcp-server-chatsum) 是一个基于 Model Context Protocol (MCP) 构建的应用后端,旨在帮助用户通过LLM客户端查询和总结自己的微信聊天记录。它通过MCP协议向客户端暴露工具,允许LLM应用访问存储在本地数据库中的微信聊天消息,从而实现基于用户聊天上下文的智能应用。
主要功能点
- 数据访问能力: 通过 'query_chat_messages' 工具,允许LLM客户端根据房间名或对话者姓名查询微信聊天记录。
- 工具 (Tools):
- 'query_chat_messages': 查询聊天消息。允许指定房间名 (room_names) 和对话者姓名 (talker_names) 作为过滤条件,并支持限制返回消息的数量 (limit)。
安装步骤
- 克隆仓库: 将仓库 'https://github.com/chatmcp/mcp-server-chatsum' 克隆到本地。
- 配置聊天数据库:
- 进入 'chatbot' 目录 ('cd chatbot')。
- 按照 'chatbot/README.md' 的说明设置聊天数据库。这通常涉及到运行 'chatbot' 目录下的微信机器人程序,用于监控和保存微信聊天消息到数据库。
- 确保 'chatbot' 目录下的 'data/chat.db' 文件存在,并且包含了你的微信聊天数据。
- 配置环境变量:
- 在仓库根目录下创建 '.env' 文件。
- 在 '.env' 文件中设置 'CHAT_DB_PATH' 环境变量,指向 'chatbot' 目录下的 'chat.db' 数据库文件路径。例如:
CHAT_DB_PATH=path-to/mcp-server-chatsum/chatbot/data/chat.db - 注意: 将 'path-to/mcp-server-chatsum' 替换为你的实际仓库路径。
- 安装依赖: 在仓库根目录下运行命令安装项目依赖:
pnpm install - 构建服务器: 运行命令构建服务器代码:
构建成功后,可执行文件将位于 'build/index.js'。pnpm build
服务器配置
要将此MCP服务器与MCP客户端(例如 Claude Desktop)配合使用,需要在客户端的MCP服务器配置文件中添加以下配置信息。以 Claude Desktop 为例,你需要编辑 'claude_desktop_config.json' 文件(路径见 README.md),并添加如下 'mcpServers' 配置:
{ "mcpServers": { "mcp-server-chatsum": { "command": "path-to/node", "args": ["path-to/mcp-server-chatsum/build/index.js"], "env": { "CHAT_DB_PATH": "path-to/mcp-server-chatsum/chatbot/data/chat.db" } } } }
配置参数说明:
- '"mcp-server-chatsum"': 服务器名称,可以自定义。
- '"command"': 启动服务器的命令。通常为 'node' (如果你的环境中 node 已添加到 PATH 环境变量,否则需要使用 node 的完整路径,例如 '/usr/local/bin/node' 或 'C:\Program Files\nodejs\node.exe')。
- '"args"': 传递给启动命令的参数,这里指向构建后的服务器入口文件 'path-to/mcp-server-chatsum/build/index.js'。请务必将 'path-to/mcp-server-chatsum' 替换为你的实际仓库路径。
- '"env"': 环境变量配置。'CHAT_DB_PATH' 必须指向你的聊天数据库文件路径,确保与你在 '.env' 文件中配置的路径一致。 请务必将 'path-to/mcp-server-chatsum' 替换为你的实际仓库路径。
基本使用方法
- 确保已经按照安装步骤配置并启动了 'chatbot',并且已经积累了一定的微信聊天数据到数据库中。
- 按照服务器配置说明,将 'mcp-server-chatsum' 服务器配置添加到你的MCP客户端 (如 Claude Desktop) 的配置文件中。
- 启动 MCP 客户端。客户端应该能够检测到并连接到 'mcp-server-chatsum' 服务器。
- 在 MCP 客户端中,你可以指示 LLM 调用 'query_chat_messages' 工具,并提供相应的参数(例如 'room_names', 'talker_names')来查询和总结你的微信聊天记录。具体的工具调用方式取决于你使用的 MCP 客户端。
例如,在 Claude 中,你可以指示 Claude 使用 'query_chat_messages' 工具来总结特定群组或特定联系人的聊天记录。
信息
分类
通信与社交