使用说明

项目简介

'mcp-server-chatsum' 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在帮助用户利用大型语言模型 (LLM) 总结聊天消息。它通过提供工具来查询本地存储的聊天记录,并将查询结果以结构化的方式提供给 LLM 客户端,例如 Claude Desktop,从而实现智能的聊天摘要功能。

主要功能点

  • 工具 (Tools):
    • 'query_chat_messages': 允许用户根据指定的参数(如聊天室名称、对话者名称等)查询聊天消息。查询结果可以用于后续的聊天总结或其他LLM应用。

安装步骤

  1. 配置环境变量: 在项目根目录下创建 '.env' 文件,并设置 'CHAT_DB_PATH' 环境变量,指向您的聊天数据库文件 'chat.db' 的路径。如果您还没有聊天数据库,需要先按照仓库 'README.md' 中的 Before you start 指引,启动 'chatbot' 目录下的微信机器人以收集聊天消息。

    CHAT_DB_PATH=path-to/chatbot/data/chat.db

    请将 'path-to/chatbot/data/chat.db' 替换为 'chatbot' 目录中实际 'chat.db' 文件的绝对路径。

  2. 安装依赖: 打开终端,进入项目根目录,运行以下命令安装项目依赖:

    pnpm install
  3. 构建服务器: 运行以下命令构建服务器代码:

    pnpm build

    构建成功后,会在项目根目录下的 'build' 文件夹中生成服务器的可执行文件 'index.js'。

服务器配置

要将此 MCP 服务器与 MCP 客户端(例如 Claude Desktop)配合使用,您需要配置客户端以连接到此服务器。以下是在 'claude_desktop_config.json' 文件中添加服务器配置的示例。请根据您的实际安装路径进行调整。

{
  "mcpServers": {
    "mcp-server-chatsum": {
      "command": "path-to/bin/node",  // Node.js 可执行文件的路径,通常为 /usr/bin/node 或 /usr/local/bin/node,请根据您的系统环境确认
      "args": ["path-to/mcp-server-chatsum/build/index.js"], // MCP 服务器入口文件 build/index.js 的路径,请替换为实际路径
      "env": {
        "CHAT_DB_PATH": "path-to/mcp-server-chatsum/chatbot/data/chat.db" // 聊天数据库文件 chat.db 的路径,需要与 .env 文件中配置的路径一致
      }
    }
  }
}

配置参数说明:

  • 'server name': '"mcp-server-chatsum"' - 服务器的名称,可以自定义,用于在 MCP 客户端中标识该服务器。
  • 'command': '"path-to/bin/node"' - 启动服务器的命令,这里是 Node.js 的可执行文件路径。
  • 'args': '["path-to/mcp-server-chatsum/build/index.js"]' - 传递给 'command' 的参数,这里指定了服务器入口文件 'build/index.js' 的路径。
  • 'env': 环境变量配置,'CHAT_DB_PATH' 指定了聊天数据库的路径,确保与服务器运行时能够访问到数据库文件。

请将 'path-to' 替换为您的 'mcp-server-chatsum' 项目的实际安装路径。'claude_desktop_config.json' ���件的位置取决于您的操作系统:

  • MacOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
  • Windows: '%APPDATA%/Claude/claude_desktop_config.json'

如果文件不存在,请手动创建。

基本使用方法

  1. 确保 MCP 服务器已成功配置并启动。

  2. 在 MCP 客户端(例如 Claude Desktop)中,您应该能够看到名为 '"mcp-server-chatsum"' 的服务器已连接。

  3. 在客户端的对话界面中,您可以指示 LLM 使用 'query_chat_messages' 工具来查询聊天记录。例如,您可以向 Claude 提问: '请总结一下我和张三在“项目讨论群”里的聊天内容。'

  4. 客户端会将您的请求转换为对 'query_chat_messages' 工具的调用,并传递相应的参数(例如,从您的自然语言指令中提取 "项目讨论群" 和 "张三" 作为参数)。

  5. 'mcp-server-chatsum' 服务器会执行工具,查询数据库中的聊天记录,并将结果返回给客户端。

  6. 客户端接收到聊天记录后,会将其作为上下文提供给 LLM,从而实现基于聊天记录的总结或其他功能。

请注意,具体的工具调用和参数传递方式取决于您使用的 MCP 客户端的功能和界面。

信息

分类

通信与社交