Txtai Assistant MCP

🚀 TxtAI 助手 MCP プロジェクト

TxtAI 助手 MCP は、txtai ライブラリをベースにしたメモリ認知プロセッサ（MCP）で、意味検索とメモリ管理に使用されます。このプロジェクトは、情報の保存、検索、管理を通じて、対話システムのコンテキスト認識能力を強化することを目的としています。

🚀 クイックスタート

TxtAI 助手 MCP は、txtai ライブラリを利用して、意味検索とメモリ管理を行うメモリ認知プロセッサです。以下に、基本的な使い方を説明します。

✨ 主な機能

TxtAI の概要

TxtAI は強力なテキスト処理ライブラリで、以下の主要な機能をサポートしています。

• 意味検索：類似度に基づくテキスト検索
• ニューラル検索：トランスフォーマーモデルを使用したテキストマッチング
• 要約生成：長いテキストから重要な情報を抽出
• 質問応答システム：コンテキストに関連する質問に回答

プロジェクトの特徴

• 意味検索：類似度計算により関連するメモリを検索
• 永続的な保存：ファイルシステムにメモリとタグインデックスを保存
• タグによる組織化：タグベースの効率的な検索をサポート
• メタデータのサポート：カスタム情報の追加を許可
• マルチスレッド処理：パフォーマンスとリソース利用率を最適化
• セキュリティ機構：ディレクトリトラバーサル攻撃を防止し、入力検証を確保

📦 インストール

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
   

📚 ドキュメント

設定ファイル

プロジェクトの設定情報は .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"
  },
  "tags": ["例", "メモリ"],
  "type": "一般"
}

メモリの検索

意味検索により内容を検索します。

{
  "query": "検索キーワード",
  "result_count": 5,
  "similarity_threshold": 0.7
}

タグによる検索

タグに基づいてメモリを検索します。

{
  "tags": ["例", "メモリ"]
}

メモリの削除

内容のハッシュを使用して特定のメモリを削除します。

DELETE /memory/{content_hash}

API エンドポイント

メモリの保存

POST /store

リクエストボディ：

{
  "content": "保存する情報",
  "metadata": {
    "ソース": "例",
    "タイムスタンプ": "2023-01-01T00:00:00Z"
  },
  "tags": ["重要", "メモリ"],
  "type": "デフォルト"
}

メモリの検索

POST /search

リクエストボディ：

{
  "query": "検索内容",
  "result_count": 5,
  "similarity_threshold": 0.6
}

プロジェクト構造

txtai-assistant-mcp/
├── data/          # メモリとタグインデックスを保存するフォルダ
├── logs/         # ログファイルの保存場所
├── scripts/      # 起動スクリプトやその他のツールが含まれる
└── txtai_mcp.py  # 核心処理ロジック

💻 使用例

基本的な使用法

1. サービスを起動します。

   python txtai_mcp.py
   

2. 保存リクエストを送信します。

   curl -X POST http://localhost:5000/store -H "Content-Type: application/json" -d '{"content":"これは最初のメモリです","tags":["テスト","初期"]}'
   

3. メモリを検索します。

   curl -X POST http://localhost:5000/search -H "Content-Type: application/json" -d '{"query":"テスト"}'
   

関連リソース

• txtai 公式ドキュメント
• MCP プロジェクトホームページ

📄 ライセンス

このプロジェクトは MIT ライセンスに従います。詳細な条項は LICENSE ファイルを参照してください。