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 文件。