Knowledge Base MCP Server

🚀 知識ベース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-mpnet-base-v2" です。
• 以下の環境変数をシェルの設定ファイル（例：.bashrc や .zshrc）に追加してください。

export HUGGINGFACE_API_KEY="your_api_key"
export KNOWLEDGE_BASES_ROOT_DIR="/path/to/knowledge_bases"
export FAISS_INDEX_PATH="/path/to/faiss_index"

4. サーバーを起動する：

npm run dev

💻 使用例

知識ベース管理ツール (manage_knowledge_base)

このツールは、知識ベースの作成と更新に使用されます。以下のコマンドで操作できます。

npm run manage-knowledge-base

基本的な使用法

新しい知識ベースを作成する

node manage_knowledge_base.js create <knowledge_base_name>

既存の知識ベースを更新する

node manage_knowledge_base.js update <knowledge_base_name> --add <file_path> [--recursive]

検索ツール (retrieve_knowledge)

このツールは、知識ベースから情報を検索するために使用されます。以下のコマンドで操作できます。

npm run retrieve-knowledge

基本的な使用法

すべての知識ベースを検索する

node retrieve_knowledge.js search "您的查询问题"

特定の知識ベースを指定する

node retrieve_knowledge.js search --knowledge_base <knowledge_base_name> "您的查询问题"

結果の数と閾値を設定する

node retrieve_knowledge.js search --top_n 5 --threshold 1.5 "您的查询问题"

高度な使用法

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

## 同義語検索結果

**結果 1:**

[最も関連する段落の内容]

**ソース:**
```json
{
  "source": "[段落を含むファイルのパス]"
}

結果 2:

[2番目に関連する段落の内容]

ソース:

{
  "source": "[段落を含むファイルのパス]"
}

免責事項: 提供される結果がすべて関連するとは限りません。情報の関連性を相互に検証してください。

各結果には、最も関連する段落の内容、ソースファイルのパス、および類似度スコアが含まれています。

## 📚 ドキュメント
### 知識ベース管理ツール (`manage_knowledge_base`)
#### 新しい知識ベースを作成する
```bash
node manage_knowledge_base.js create <knowledge_base_name>

このコマンドは、$KNOWLEDGE_BASES_ROOT_DIR ディレクトリ内に <knowledge_base_name> という名前の新しい知識ベースディレクトリを作成し、必要な設定ファイルを初期化します。

既存の知識ベースを更新する

node manage_knowledge_base.js update <knowledge_base_name> --add <file_path> [--recursive]

このコマンドでは、指定された知識ベースにファイルを追加できます。--recursive フラグを有効にすると、指定されたパスとそのサブディレクトリ内のすべてのファイルを再帰的に検索します。

検索ツール (retrieve_knowledge)

基本的な検索

node retrieve_knowledge.js search "您的查询问题"

このコマンドは、登録されているすべての知識ベースを検索し、クエリに最も関連する段落を返します。

特定の知識ベースを指定する

node retrieve_knowledge.js search --knowledge_base <knowledge_base_name> "您的查询问题"

このコマンドでは、検索する特定の知識ベースを指定できます。

結果の数と類似度の閾値を制御する

node retrieve_knowledge.js search --top_n 5 --threshold 1.5 "您的查询问题"

--top_n パラメータで、返される最大結果数を制御できます。--threshold パラメータで、類似度スコアの最低閾値を設定できます。

バックグラウンドで実行する

サーバーをバックグラウンドサービスとして実行するには、プロジェクト内のサービス起動スクリプトと設定ファイルを参照してください。

🔧 技術詳細

プロジェクト構造

knowledge-base-mcp-server/
├── package.json           # プロジェクトのnpmパッケージ設定
├── src/                  # ソースコードディレクトリ
│   ├── manage_knowledge_base.js  # 知識ベース管理ツール
│   └── retrieve_knowledge.js     # 検索ツール
└── README.md             # プロジェクトの説明ドキュメント

依存関係

{
  "dependencies": {
    "@sentence-transformers/all-mpnet-base-v2": "^1.14.0",
    "faiss-js": "^0.5.3",
    "fs-extra": "^9.1.0",
    "node-yaml": "^5.1.0"
  }
}

📄 ライセンス

貢献者

• [あなたの名前またはGitHubユーザー名]

謝辞

このプロジェクトへの貢献に感謝します！