Skip to main content

MCP server for intelligent knowledge base search and retrieval with Dify integration

Project description

KB-Bridge

Tests Code Coverage

A Model Context Protocol (MCP) server for intelligent knowledge base search and retrieval with support for multiple backend providers.

Installation

pip install kbbridge

Quick Start

Configuration

Create a .env file with your retrieval backend credentials:

# Required - Retrieval Backend Configuration
RETRIEVAL_ENDPOINT=https://api.dify.ai/v1  # Example: Dify endpoint
RETRIEVAL_API_KEY=your-retrieval-api-key
LLM_API_URL=https://your-llm-service.com/v1
LLM_MODEL=gpt-4o
LLM_API_TOKEN=your-token-here

# Optional
RERANK_URL=https://your-rerank-api.com
RERANK_MODEL=your-rerank-model

Supported Backends:

Backend Status Notes
Dify Supported Currently available
Others Planned Additional backends coming soon

See env.example for all available configuration options.

Running the Server

# Start server
python -m kbbridge.server --host 0.0.0.0 --port 5210

# Or using Makefile (if available)
make start

Server runs on http://0.0.0.0:5210 with MCP endpoint at http://0.0.0.0:5210/mcp.

Features

  • Backend Integration: Extensible architecture supporting multiple retrieval backends
  • Multiple Search Methods: Hybrid, semantic, keyword, and full-text search
  • Quality Reflection: Automatic answer quality evaluation and refinement
  • Custom Instructions: Domain-specific query guidance

Available Tools

  • assistant: Intelligent search and answer extraction from knowledge bases
  • file_discover: Discover relevant files using retriever + optional reranking
  • file_lister: List files in knowledge base datasets
  • keyword_generator: Generate search keywords using LLM
  • retriever: Retrieve information using various search methods
  • file_count: Get file count in knowledge base dataset

Usage Examples

Basic Query

import asyncio
from mcp import ClientSession

async def main():
    async with ClientSession("http://localhost:5210/mcp") as session:
        result = await session.call_tool("assistant", {
            "dataset_info": json.dumps([{"id": "dataset_id", "name": "Dataset"}]),
            "query": "What are the safety protocols?"
        })
        print(result.content[0].text)

asyncio.run(main())

With Custom Instructions

await session.call_tool("assistant", {
    "dataset_info": json.dumps([{"id": "hr_dataset", "name": "HR Policies"}]),
    "query": "What is the maternity leave policy?",
    "custom_instructions": "Focus on HR compliance and legal requirements."
})

With Quality Reflection

await session.call_tool("assistant", {
    "dataset_info": json.dumps([{"id": "dataset_id", "name": "Dataset"}]),
    "query": "What are the safety protocols?",
    "reflection_mode": "standard",  # "off", "standard", or "comprehensive"
    "reflection_threshold": 0.75,
    "max_reflection_iterations": 2
})

Reflection Modes

  • off: No reflection (fastest)
  • standard (default): Answer quality evaluation only
  • comprehensive: Search coverage + answer quality evaluation

Reflection evaluates answers on:

  • Completeness (30%): Does the answer fully address the query?
  • Accuracy (30%): Are sources relevant and correctly cited?
  • Relevance (20%): Does the answer stay on topic?
  • Clarity (10%): Is the answer clear and well-structured?
  • Confidence (10%): Quality of supporting sources?

Development

# Install development dependencies
pip install -e ".[dev]"

# Run tests
pytest tests/

# Format code
black kbbridge/ tests/

# Lint code
ruff check kbbridge/ tests/

License

Apache-2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kbbridge-0.1.0.tar.gz (90.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kbbridge-0.1.0-py3-none-any.whl (118.0 kB view details)

Uploaded Python 3

File details

Details for the file kbbridge-0.1.0.tar.gz.

File metadata

  • Download URL: kbbridge-0.1.0.tar.gz
  • Upload date:
  • Size: 90.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for kbbridge-0.1.0.tar.gz
Algorithm Hash digest
SHA256 b7b74d0d904d8f47b5e692dfbdb9290ee49589f3d4105243d7838cc90477b553
MD5 8cc4ea0d7d5df36f6690c2cd2ed1a8b1
BLAKE2b-256 aff5ef71fae47e3bd98a57f3e2d8e817bc3cc88cee6acc0411b6b5867f1f5ca6

See more details on using hashes here.

File details

Details for the file kbbridge-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: kbbridge-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 118.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for kbbridge-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b985f3406b428d7cb0212eab4a5338e248ebde24c8b78cf987e58e6e81b29c59
MD5 a1b3e301fd246dc9f206d9321dcc7f09
BLAKE2b-256 0ba80b467d2c3680eef0717ccd7dfaa933860c06bcd103ecf0c1ce98ba97e3f7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page