使用说明

项目简介

mcp-server-chatsum 是一个 MCP (Model Context Protocol) 服务器,旨在为大型语言模型 (LLM) 提供访问用户本地聊天记录的能力。它通过提供 'query_chat_messages' 工具,允许 LLM 根据指定的条件查询和检索聊天消息,从而将用户的历史对话内容作为上下文信息提供给 LLM 使用,增强对话的个性化和情境感知。

主要功能点

  • 查询聊天消息工具 (query_chat_messages): 允许 LLM 客户端通过指定房间名称或对话者名称,查询存储在本地数据库中的聊天记录。该工具可以帮助 LLM 理解用户过往的对话内容,从而在后续对话中提供更相关的回复和建议。

安装步骤

  1. 设置聊天数据库 (chatbot):
    • 请先移步到仓库的 'chatbot' 目录下,并按照 'chatbot/README.md' 的说明,设置用于存储聊天记录的数据库。这通常涉及到配置和启动一个聊天机器人,用于捕获和保存用户的聊天消息。
  2. 配置环境变量:
    • 在 'mcp-server-chatsum' 仓库根目录下创建 '.env' 文件。
    • 在 '.env' 文件中设置 'CHAT_DB_PATH' 环境变量,指向您在步骤1中设置的聊天数据库文件路径。例如:
      CHAT_DB_PATH=path-to/chatbot/data/chat.db
  3. 安装依赖:
    • 在 'mcp-server-chatsum' 仓库根目录下,运行 'pnpm install' 命令安装项目依赖。
  4. 构建服务器:
    • 运行 'pnpm build' 命令编译服务器代码。

服务器配置

为了将 mcp-server-chatsum 集成到 MCP 客户端(例如 Claude Desktop),您需要在客户端的配置文件中添加以下服务器配置信息。通常,配置文件是 JSON 格式,例如 Claude Desktop 的 'claude_desktop_config.json' 文件。

以下是您需要添加到配置文件 'mcpServers' 字段中的配置信息:

{
  "mcpServers": {
    "mcp-server-chatsum": {
      "command": "path-to/bin/node",  // Node.js 运行时可执行文件的路径,请根据您的系统环境配置
      "args": ["path-to/mcp-server-chatsum/build/index.js"], //  mcp-server-chatsum 构建后 index.js 文件的路径,请根据您的项目实际路径配置
      "env": {
        "CHAT_DB_PATH": "path-to/mcp-server-chatsum/chatbot/data/chat.db" //  聊天数据库文件路径,需要与您在 .env 文件中设置的路径保持一致
      }
    }
  }
}

请注意:

  • 'command' 和 'args' 字段中的路径需要根据您的实际环境进行调整,确保指向正确的 Node.js 可执行文件和 'mcp-server-chatsum' 服务器程序的入口文件。
  • 'CHAT_DB_PATH' 环境变量需要与您在 '.env' 文件中设置的路径一致,确保服务器能够找到聊天数据库文件。

基本使用方法

  1. 启动 MCP 服务器: MCP 服务器通常由 MCP 客户端(如 Claude Desktop)在需要时自动启动。您无需手动运行服务器,只需确保已正确配置 MCP 客户端的配置文件。
  2. 在 MCP 客户端中使用工具: 当 MCP 服务器成功配置并运行后,您的 MCP 客户端应该能够检测到 'mcp-server-chatsum' 服务器提供的 'query_chat_messages' 工具。具体如何使用该工具取决于 MCP 客户端的应用界面和功能设计。通常,您可以在与 LLM 对话时,通过特定的指令或操作来触发调用该工具,从而将相关的聊天记录作为上下文信息提供给 LLM。

通过以上步骤,您就可以成功安装、配置和使用 mcp-server-chatsum MCP 服务器,为您的 LLM 应用提供强大的本地聊天记录上下文支持。

信息

分类

数据库与文件