txtai-assistant-mcp

🚀 TxtAI 助手 MCP 项目

TxtAI 助手 MCP 是基于 txtai 库实现的内存认知处理器（MCP），用于语义搜索和记忆管理。该项目可通过存储、检索和管理信息，增强对话系统的上下文感知能力。

🚀 快速开始

TxtAI 助手 MCP 是一个强大的工具，以下为你介绍其使用的基本步骤：

1. 克隆项目仓库：

   git clone https://github.com/yourusername/txtai-assistant-mcp.git
   cd txtai-assistant-mcp
   

2. 运行启动脚本：

   ./scripts/start.sh
   

3. 创建并激活虚拟环境（推荐）：

   python -m venv venv
   source venv/bin/activate  # 对于 Linux/Mac
   venv\Scripts\activate      # 对于 Windows
   

4. 启动服务：

   python txtai_mcp.py
   

5. 发送存储请求：

   curl -X POST http://localhost:5000/store -H "Content-Type: application/json" -d '{"内容":"这是第一条记忆","标签":["测试","初始"]}'
   

6. 检索记忆：

   curl -X POST http://localhost:5000/search -H "Content-Type: application/json" -d '{"查询":"测试"}'
   

✨ 主要特性

• 语义搜索：通过相似度计算检索相关记忆。
• 持久存储：在文件系统中保存记忆和标签索引。
• 标签组织：支持基于标签的高效检索。
• 元数据支持：允许附加自定义信息。
• 多线程处理：优化了性能和资源利用率。
• 安全机制：防止目录遍历攻击，确保输入验证。

📦 安装指南

1. 克隆项目仓库：

   git clone https://github.com/yourusername/txtai-assistant-mcp.git
   cd txtai-assistant-mcp
   

2. 运行启动脚本：

   ./scripts/start.sh
   

3. 创建并激活虚拟环境（推荐）：

   python -m venv venv
   source venv/bin/activate  # 对于 Linux/Mac
   venv\Scripts\activate      # 对于 Windows
   

💻 使用示例

基础用法

# 启动服务
python txtai_mcp.py

# 发送存储请求
curl -X POST http://localhost:5000/store -H "Content-Type: application/json" -d '{"内容":"这是第一条记忆","标签":["测试","初始"]}'

# 检索记忆
curl -X POST http://localhost:5000/search -H "Content-Type: application/json" -d '{"查询":"测试"}'

📚 详细文档

TxtAI 简介

TxtAI 是一个功能强大的文本处理库，支持以下核心功能：

• 语义搜索：基于相似度的文本检索。
• 神经搜索：使用转换器模型进行文本匹配。
• 摘要生成：从长文本中提取关键信息。
• 问答系统：回答与上下文相关的问题。

配置文件

项目的配置信息存储在 .env.template 文件中，具体内容如下：

# 日志设置
LOG_LEVEL=INFO
LOG_FILE=./logs/server.log

# 存储路径
DATA_PATH=./data

# 网络设置
SERVER_HOST=127.0.0.1
SERVER_PORT=5000

与 Claude 和 Cline 整合

修改配置文件

在 Claude 或 Cline 中启用 MCP 功能，需编辑其配置文件：

在 Claude 中：

// config.js
{
  "mcp": {
    "enabled": true,
    "host": "127.0.0.1",
    "port": 5000
  }
}

在 Cline 中：

// settings.json
{
  "integrations": {
    "txtai_mcp": {
      "url": "http://localhost:5000"
    }
  }
}

MCP 工具集

存储记忆

使用 /store 端点创建新记忆：

{
  "content": "待存储的信息内容",
  "metadata": {
    "来源": "示例",
    "时间戳": "2023-01-01T00:00:00Z"
  },
  "标签": ["示例", "记忆"],
  "类型": "通用"
}

检索记忆

通过语义查询检索内容：

{
  "查询": "搜索关键词",
  "结果数量": 5,
  "相似度阈值": 0.7
}

标签检索

基于标签查找记忆：

{
  "标签": ["示例", "记忆"]
}

删除记忆

通过内容哈希删除特定记忆：

DELETE /memory/{content_hash}

API 端点

存储记忆

POST /store

请求体：

{
  "内容": "待存储的信息",
  "元数据": {
    "来源": "例子",
    "时间戳": "2023-01-01T00:00:00Z"
  },
  "标签": ["重要", "记忆"],
  "类型": "默认"
}

检索记忆

POST /search

请求体：

{
  "查询": "搜索内容",
  "结果数量": 5,
  "相似度阈值": 0.6
}

项目结构

txtai-assistant-mcp/
├── data/          # 存储记忆和标签索引的文件夹
├── logs/         # 日志文件存储位置
├── scripts/      # 包含启动脚本和其他工具
└── txtai_mcp.py  # 核心处理逻辑

相关资源

• txtai 官方文档
• MCP 项目主页

📄 许可证

本项目遵循 MIT 协议，具体条款请参阅 LICENSE 文件。