Knowledge Base MCP Server

🚀 Knowledge Base MCP Server

This MCP server provides tools to list and retrieve content from different knowledge bases.

🚀 Quick Start

✨ Features

This server offers tools for managing and retrieving knowledge from various knowledge bases, including creating, updating knowledge bases, and searching for relevant information.

📦 Installation

These instructions assume you have already installed Node.js and npm on your system.

Prerequisites

• Node.js (Version 16 or higher)
• npm (Node Package Manager)

1. Clone the repository:

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

2. Install dependencies:

   npm install
   

3. Configure environment variables:

   • The server requires the HUGGINGFACE_API_KEY environment variable to be set. This is the Hugging Face Inference API key used to generate embeddings for knowledge base content. You can obtain an API key for free on the Hugging Face website (https://huggingface.co/).
   • The server requires the KNOWLEDGE_BASES_ROOT_DIR environment variable to be set. This variable specifies the directory where the knowledge base subdirectories are located. If you do not set this variable, it will default to $HOME/knowledge_bases, where $HOME is the current user's home directory.
   • The server supports the FAISS_INDEX_PATH environment variable to specify the path to the FAISS index. If not set, the default value is $HOME/knowledge_bases/.faiss.
   • The server supports the HUGGINGFACE_MODEL_NAME environment variable to specify the Hugging Face model used to generate embeddings. If not set, the default value is "sentence-transformers/all-mpnet-base-v2".
   • Add the following environment variables to your shell configuration file (e.g., .bashrc or .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. Run the server:

   npm run dev
   

💻 Usage Examples

Knowledge Base Management Tool (manage_knowledge_base)

This tool is used to create and update knowledge bases. You can interact with it using the following command:

npm run manage-knowledge-base

Basic Usage - Create a New Knowledge Base

node manage_knowledge_base.js create <knowledge_base_name>

Advanced Usage - Update an Existing Knowledge Base

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

Retrieval Tool (retrieve_knowledge)

This tool is used to retrieve information from knowledge bases. You can interact with it using the following command:

npm run retrieve-knowledge

Basic Usage - Search All Knowledge Bases

node retrieve_knowledge.js search "your_query"

Advanced Usage - Specify a Specific Knowledge Base

node retrieve_knowledge.js search --knowledge_base <knowledge_base_name> "your_query"

Advanced Usage - Set the Number of Results and Threshold

node retrieve_knowledge.js search --top_n 5 --threshold 1.5 "your_query"

Output Format

The output of the retrieval tool is a Markdown-formatted string with the following structure:

## Synonym Search Results

**Result 1:**

[Most relevant paragraph content]

**Source:**
```json
{
  "source": "[File path containing the paragraph]"
}
```

---

**Result 2:**

[Second most relevant paragraph content]

**Source:**
```json
{
  "source": "[File path containing the paragraph]"
}
```

> **Disclaimer:** Not all provided results may be relevant. Please cross-verify the relevance of the information.

Each result includes the most relevant paragraph content, the source file path, and the similarity score.

📚 Documentation

Knowledge Base Management Tool (manage_knowledge_base)

Create a New Knowledge Base

node manage_knowledge_base.js create <knowledge_base_name>

This command creates a new knowledge base directory named <knowledge_base_name> in the $KNOWLEDGE_BASES_ROOT_DIR directory and initializes the necessary configuration files.

Update an Existing Knowledge Base

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

This command allows you to add files to the specified knowledge base. If the --recursive flag is enabled, it will recursively search for all files in the given path and its subdirectories.

Retrieval Tool (retrieve_knowledge)

Basic Retrieval

node retrieve_knowledge.js search "your_query"

This command searches all registered knowledge bases and returns the paragraphs most relevant to the query.

Specify a Knowledge Base

node retrieve_knowledge.js search --knowledge_base <knowledge_base_name> "your_query"

This command allows you to specify a specific knowledge base to search.

Control the Number of Results and Similarity Threshold

node retrieve_knowledge.js search --top_n 5 --threshold 1.5 "your_query"

You can control the maximum number of results returned using the --top_n parameter. You can set the minimum threshold for the similarity score using the --threshold parameter.

Run in the Background

To run the server as a background service, refer to the service startup script and configuration files in the project.

🔧 Technical Details

Project Structure

knowledge-base-mcp-server/
├── package.json           # Project's npm package configuration
├── src/                  # Source code directory
│   ├── manage_knowledge_base.js  # Knowledge base management tool
│   └── retrieve_knowledge.js     # Retrieval tool
└── README.md             # Project documentation

Dependencies

{
  "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"
  }
}

📄 License

👥 Contributors

• [Your Name or GitHub Username]

🙏 Acknowledgments

Thank you for your contributions to this project!