ナレッジベースMCPサーバー

この MCP サーバーは、さまざまなナレッジ ベースからコンテンツを一覧表示および取得するためのツールを提供します。

セットアップ手順

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

前提条件

• Node.js (バージョン 16 以上)
• npm (ノード パッケージ マネージャー)

1. リポジトリをクローンします。
   git clone <repository_url> cd knowledge-base-mcp-server
2. 依存関係をインストールします:
   npm install
3. 環境変数を設定します。
   • サーバーでは、 HUGGINGFACE_API_KEY環境変数を設定する必要があります。これは、知識ベースコンテンツの埋め込みを生成するために使用されるHugging Face推論APIのAPIキーです。Hugging Faceのウェブサイト（ https://huggingface.co/ ）から無料のAPIキーを入手できます。
   • サーバーでは、 KNOWLEDGE_BASES_ROOT_DIR環境変数を設定する必要があります。この変数は、ナレッジベースのサブディレクトリが配置されているディレクトリを指定します。この変数を設定しない場合、デフォルトで$HOME/knowledge_basesが使用されます。ここで、 $HOMEは現在のユーザーのホームディレクトリです。
   • サーバーは、FAISSインデックスへのパスを指定するためのFAISS_INDEX_PATH環境変数をサポートしています。設定されていない場合は、デフォルトで$HOME/knowledge_bases/.faissが使用されます。
   • サーバーは、埋め込み生成に使用するHugging Faceモデルを指定するためのHUGGINGFACE_MODEL_NAME環境変数をサポートしています。設定されていない場合は、デフォルトでsentence-transformers/all-MiniLM-L6-v2が使用されます。
   • これらの環境変数は、 .bashrcまたは.zshrcファイルで設定することも、MCP 設定で直接設定することもできます。
4. サーバーを構築します。
   npm run build
5. サーバーを MCP 設定に追加します。
   • /home/jean/.vscode-server/data/User/globalStorage/saoudrizwan.claude-dev/settings/にあるcline_mcp_settings.jsonファイルを編集します。
   • mcpServersオブジェクトに次の構成を追加します。
   "knowledge-base-mcp": { "command": "node", "args": [ "/path/to/knowledge-base-mcp-server/build/index.js" ], "disabled": false, "autoApprove": [], "env": { "KNOWLEDGE_BASES_ROOT_DIR": "/path/to/knowledge_bases", "HUGGINGFACE_API_KEY": "YOUR_HUGGINGFACE_API_KEY", }, "description": "Retrieves similar chunks from the knowledge base based on a query." },
   • /path/to/knowledge-base-mcp-serverサーバー ディレクトリへの実際のパスに置き換えます。
   • /path/to/knowledge_basesナレッジ ベース ディレクトリへの実際のパスに置き換えます。
6. ナレッジ ベース ディレクトリを作成します。
   • 各ナレッジ ベース (例: company 、 it_support 、 onboarding ) のKNOWLEDGE_BASES_ROOT_DIR内にサブディレクトリを作成します。
   • これらのサブディレクトリ内に、ナレッジ ベースのコンテンツを含むテキスト ファイル (例: .txt 、 .md ) を配置します。

• サーバーは、指定されたナレッジ ベースのサブディレクトリ内のすべてのテキスト ファイル (例: .txt 、 .md ) を再帰的に読み取ります。
• サーバーは隠しファイルとディレクトリ ( .で始まるもの) をスキップします。
• サーバーは各ファイルについてSHA256ハッシュを計算し、隠しサブディレクトリ.index内の同名のファイルに保存します。このハッシュは、前回のインデックス作成以降にファイルが変更されたかどうかを判断するために使用されます。
• ファイルの内容は、 langchain/text_splitterのMarkdownTextSplitterを使用してチャンクに分割されます。
• 各チャンクの内容は、類似性検索に使用される FAISS インデックスに追加されます。
• FAISSインデックスは、サーバーの起動時に自動的に初期化されます。ナレッジベースファイルの変更をチェックし、それに応じてインデックスを更新します。

使用法

サーバーは 2 つのツールを公開します。

• list_knowledge_bases : 利用可能なナレッジベースを一覧表示します。
• クエリに基づいてナレッジベースから類似のチャンクを取得しretrieve_knowledge 。オプションでナレッジベースを指定した場合は、そのナレッジベースのみが検索されます。指定しない場合は、利用可能なすべてのナレッジベースが対象となります。デフォルトでは、スコアがしきい値2未満のドキュメントチャンクが最大10個返されます。threshold thresholdを使用して、異なるしきい値を指定することもできます。

これらのツールは、MCP インターフェースを通じて使用できます。

retrieve_knowledgeツールは、FAISSインデックスを使用してセマンティック検索を実行します。インデックスは、サーバーの起動時またはナレッジベース内のファイルが変更されたときに自動的に更新されます。

retrieve_knowledgeツールの出力は、次の構造を持つマークダウン形式の文字列です。

各結果には、最も類似したチャンクのコンテンツ、ソース ファイル、および類似度スコアが含まれます。