Jeanibarz Knowledge Base MCP Server

🚀 知識ベースMCPサーバー

このMCPサーバーは、さまざまな知識ベースからのコンテンツを一覧表示し、検索するためのツールを提供します。

🚀 クイックスタート

このセクションでは、知識ベースMCPサーバーのセットアップと使用方法について説明します。

📦 インストール

これらの手順では、システムにNode.jsとnpmがインストールされていることを前提としています。

前提条件

• Node.js（バージョン16以上）
• npm（Nodeパッケージマネージャー）

手順

1. リポジトリをクローンする：

git clone <repository_url>
cd knowledge-base-mcp-server

2. 依存関係をインストールする：

npm install

3. 環境変数を設定する：

• サーバーは HUGGINGFACE_API_KEY 環境変数を設定する必要があります。これは、知識ベースのコンテンツの埋め込みを生成するためのHugging Face推論APIキーです。Hugging Faceのウェブサイト (https://huggingface.co/) で無料でAPIキーを取得できます。
• サーバーは KNOWLEDGE_BASES_ROOT_DIR 環境変数を設定する必要があります。この変数は、知識ベースのサブディレクトリが存在するディレクトリを指定します。設定されていない場合、デフォルトで $HOME/knowledge_bases が使用されます。ここで、$HOME は現在のユーザーのホームディレクトリです。
• サーバーは FAISS_INDEX_PATH 環境変数をサポートしており、FAISSインデックスのパスを指定できます。設定されていない場合、デフォルトは $HOME/knowledge_bases/.faiss です。
• サーバーは HUGGINGFACE_MODEL_NAME 環境変数をサポートしており、埋め込みを生成するためのHugging Faceモデルを指定できます。設定されていない場合、デフォルトで sentence-transformers/all-MiniLM-L6-v2 が使用されます。
• これらの環境変数は、.env ファイルまたはシステム環境で設定できます。

4. サーバーをビルドする：

npm run build

5. MCP設定に追加する： このサーバーをMCPインターフェイスに追加するには、MCPドキュメントの手順に従ってください。MCPがこのサーバーを正しく認識するように設定し、必要な権限を設定してください。

6. 知識ベースのディレクトリを作成する： 開始する前に、各知識ベースに適切なディレクトリ構造を作成することをお勧めします。例えば：

knowledge_bases/
  ├── doc1.md
  ├── doc2.pdf
  └── subdirectory/
      └── file.txt

💻 使用例

基本的な使用法

このサーバーは、以下の主要な機能を提供します。

知識ベースの一覧表示

登録されたすべての知識ベースとそのメタデータを取得します。

知識コンテンツの検索

クエリ文に基づいて関連する知識ドキュメントを検索します。特定の知識ベースを指定して検索することも、すべての知識ベースを対象に検索することもできます。

高度な使用法

知識検索ツール

retrieve_knowledge ツールは、FAISSインデックスを使用して意味検索を実行します。このインデックスは、サーバー起動時または知識ベースのファイルの変更を検出したときに自動的に更新されます。

出力形式

検索操作の出力は、Markdown形式の文字列で、以下のような構造になっています。

## 意味検索結果

**結果1：**

[最も類似したフラグメントの内容]

**ソース：**
```json
{
  "source": "[フラグメントを含むファイルのパス]"
}

結果2：

[2番目に類似したフラグメントの内容]

ソース：

{
  "source": "[フラグメントを含むファイルのパス]"
}

免責事項： 提供される結果はすべて関連するとは限りません。情報の関連性を確認してください。

各結果には、最も類似したフラグメントの内容、ソースファイルのパス、および類似度スコアが含まれています。

#### サンプルコード
MCPインターフェイスを介してツールを使用する例：
```json
{
  "tool": "retrieve_knowledge",
  "args": {
    "query": "あなたのクエリ文。",
    "knowledge_base": "特定の知識ベースの名前（オプション）",
    "threshold": 2.0
  }
}

パラメータ

• query：必須。検索する情報のクエリ文。
• knowledge_base：オプション。特定の知識ベースを指定して検索する場合に使用します。指定しない場合は、すべての知識ベースを対象に検索します。
• threshold：オプション。類似度の閾値。この閾値を下回る結果が返されます。デフォルトは2.0です。

サンプル出力

{
  "result": [
    {
      "content": "関連するフラグメントの内容。",
      "source": "ファイルのパス",
      "score": 1.5
    },
    {
      "content": "別の関連するフラグメントの内容。",
      "source": "別のファイルのパス",
      "score": 1.8
    }
  ],
  "message": "検索が完了しました。"
}

🔧 注意事項

• すべての知識ベースのファイルが読み取り可能で、サーバーが適切なファイル権限を持っていることを確認してください。
• インデックスを最新の状態に保つために、定期的に知識ベースを更新してください。
• 検索結果の関連性を最適化するために、類似度の閾値を調整してください。

これらの手順に従うことで、このMCPサーバーを効果的に利用して、知識コンテンツの管理、検索、および取得を行うことができます。