使用说明

项目简介

txtai-assistant-mcp 是一个基于 txtai 语义搜索引擎构建的 Model Context Protocol (MCP) 服务器。它旨在为大型语言模型 (LLM) 客户端(如 Claude 和 Cline)提供结构化的长期记忆和高效的语义搜索能力。通过该服务器,AI 助手可以存储、检索和管理文本记忆,从而在对话和任务处理中拥有更好的上下文理解和信息利用能力。

主要功能点

  • 语义记忆存储: 存储文本记忆内容,并支持关联元数据和标签。
  • 语义记忆检索: 基于语义搜索查询,快速找到相关记忆。
  • 标签搜索: 根据标签筛选和检索记忆。
  • 记忆管理: 提供记忆的删除和统计功能。
  • 健康检查: 监控服务器运行状态。
  • 持久化存储: 使用文件系统作为后端,保证数据持久性。
  • 可配置 CORS: 允许灵活配置跨域资源共享策略。
  • 集成 Claude 和 Cline: 专门为 Claude 和 Cline 等 AI 助手设计,作为 MCP 服务器扩展其能力。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/rmtech1/txtai-assistant-mcp.git
    cd txtai-assistant-mcp
  2. 运行启动脚本:
    ./scripts/start.sh
    该脚本会自动创建虚拟环境、安装依赖、设置目录和启动服务器。

服务器配置

MCP 客户端(如 Claude 或 Cline)需要配置 MCP 服务器的连接信息。以下是 txtai-assistant-mcp 服务器的 MCP 配置示例(JSON 格式):

{
  "mcpServers": {
    "txtai-assistant": {  // 服务器名称,客户端用于引用
      "command": "/path/to/txtai-assistant-mcp/scripts/start.sh", // 服务器启动命令,请替换为实际路径
      "env": {} // 环境变量,如有需要可在此配置
    }
  }
}

配置参数说明:

  • 'server name': 服务器的名称,例如 "txtai-assistant"。在客户端配置和调用工具时会使用此名称。
  • 'command': 服务器启动命令的绝对路径。需要根据 'txtai-assistant-mcp' 仓库在您本地的实际存储路径进行修改。
  • 'env': 可选的环境变量配置。如果服务器需要特定的环境变量才能运行,可以在这里设置。对于默认配置,可以留空 '{}'。

Claude 和 Cline 配置位置:

  • Claude: '~/Library/Application Support/Claude/claude_desktop_config.json' (macOS)
  • Cline: '~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json' (macOS)

请将上述 JSON 配置添加到对应客户端的配置文件中。

基本使用方法

配置完成后,在 Claude 或 Cline 中,您可以使用 '<use_mcp_tool>' 标签来调用 txtai-assistant-mcp 服务器提供的工具。

示例:存储记忆

<use_mcp_tool>
  <server_name>txtai-assistant</server_name>
  <tool_name>store_memory</tool_name>
  <arguments>
  {
    "content": "我今天学习了 MCP 协议。",
    "tags": ["学习", "MCP"]
  }
  </arguments>
</use_mcp_tool>

示例:检索记忆

<use_mcp_tool>
  <server_name>txtai-assistant</server_name>
  <tool_name>retrieve_memory</tool_name>
  <arguments>
  {
    "query": "我学了什么协议?",
    "n_results": 3
  }
  </arguments>
</use_mcp_tool>

更多工具和 API 端点信息,请参考仓库 README.md 文件。

信息

分类

AI与计算