fayna-rag-mcp
Enables local knowledge base management with retrieval-augmented generation (RAG), providing semantic search, document reading, listing, and Q&A via MCP tools and REST endpoints, all running locally without cloud dependencies.
README
fayna-rag-mcp — lokalna baza wiedzy z RAG i MCP
Opracowane przez Fayna Digital Autor: Volodymyr Shevchenko
Problem: zespół gromadzi dokumentację (polityki, podręczniki, notatki) w plikach i szybko traci do niej dostęp w języku naturalnym — wyszukiwanie po nazwie pliku czy Ctrl+F nie skaluje się, a wysyłanie wewnętrznych dokumentów do chmurowego serwisu LLM nie zawsze jest akceptowalne ze względu na prywatność.
Rozwiązanie: lokalny potok RAG (FAISS + wielojęzyczne embeddingi) na bazie lokalnego LLM (Ollama) — a ten sam wyszukiwacz/Q&A wystawiony jako serwer MCP, aby mógł z niego korzystać dowolny klient MCP (Claude Desktop/Code itp.) lub zewnętrzny zautomatyzowany workflow przez proste trasy REST. Żadne dane nie opuszczają maszyny, na której to działa.
Rezultat: pięć narzędzi MCP i cztery trasy REST do wyszukiwania semantycznego, RAG Q&A ze źródłami, czytania dokumentów i offline-katalogowania — gotowe do podłączenia do Claude czy n8n w kilka minut, bez zależności chmurowych.
Możliwości
| Narzędzie (MCP) | Przeznaczenie |
|---|---|
read_document(file_path) |
odczyt pełnego pliku z bazy (z guardem na path-traversal w obrębie DOCUMENTS_DIR) |
list_documents() |
lista wszystkich dokumentów (.txt, .md, .pdf, .docx) |
search_documents(query) |
wyszukiwanie semantyczne FAISS → top-relewantne chunki |
ask_knowledge_base(question) |
odpowiedź RAG: FAISS-retrieve + Ollama LLM, ze źródłami |
show_catalog() |
read-only katalog tagów dokumentów (temat/typ/język/audytorium) |
| Trasa REST | Body | Co robi |
|---|---|---|
POST /search |
{"query": …} |
FAISS-retrieve → {results:[{source,text}]} |
POST /ask |
{"question": …} |
odpowiedź RAG → {answer, sources} |
POST /find |
{"query": …} |
dokładne wyszukiwanie podciągu po .md/.txt w korpusie |
POST /hybrid |
{"query": …} |
hybryda: transliteracja cyrylica↔łacinka + token-match, dobór semantyką |
Stack
Python 3.10+ · FAISS (faiss-cpu) · sentence-transformers · tiktoken ·
Ollama · FastMCP · Tesseract/poppler/Whisper do multi-formatowego ingestu ·
Docker.
Potok RAG
docs/ → load (.txt/.md/.pdf/.docx) → chunk (tiktoken) → embed (mpnet) → FAISS → retrieve → Ollama → answer + sources
- Chunking — po tokenach
tiktoken(cl100k_base), nie po znakach. DomyślnieCHUNK_SIZE=700tokenów,CHUNK_OVERLAP=100tokenów. - Embeddingi:
paraphrase-multilingual-mpnet-base-v2— model wielojęzyczny (UA/PL/EN/RU i inne), aby wyszukiwanie działało niezależnie od języka zapytania. - LLM: dowolny model Ollama, domyślnie
qwen2.5:7b. - Indeks: FAISS
IndexFlatIP(bliskość kosinusowa),TOP_K=5.
Szybki start
pip install -r src/requirements.txt
# Przykład: demo-korpus na kilka dokumentów (sample-docs/)
export DOCUMENTS_DIR=./sample-docs
python -m src.main build-index # → src/index/index.faiss + chunks.pkl
# Interaktywne Q&A (CLI)
python -m src.main
# Serwer MCP (transport z env MCP_TRANSPORT: stdio|http)
python -m src.mcp.server
Testy:
pip install -r tests/requirements-dev.txt
pytest -q
Docker
docker compose up -d
Domyślne wartości w docker-compose.yml/Dockerfile są zaprojektowane pod Ollama
działające na hoście (przez host.docker.internal); dopasuj OLLAMA_URL do
własnej sieci (adres bridge na Linuxie, osobny kontener Ollama itp.).
Konfiguracja (src/config.py, wszystko przez env)
| Env | Domyślnie | Opis |
|---|---|---|
DOCUMENTS_DIR |
./docs |
korzeń bazy wiedzy |
EMBEDDING_MODEL |
paraphrase-multilingual-mpnet-base-v2 |
model embeddingów |
OLLAMA_MODEL |
qwen2.5:7b |
LLM do odpowiedzi RAG |
OLLAMA_URL |
http://localhost:11434/api/generate |
endpoint Ollama |
CHUNK_SIZE / CHUNK_OVERLAP |
700 / 100 |
tokeny (tiktoken), nie znaki |
TOP_K |
5 |
ile chunków zwraca retrieve |
MCP_TRANSPORT |
stdio |
stdio (dla lokalnego klienta MCP) lub http → FastMCP streamable-http |
MCP_HOST / MCP_PORT |
0.0.0.0 / 8765 |
adres przy MCP_TRANSPORT=http |
Podłączenie do dowolnego klienta MCP — przez jego konfigurację serwerów MCP,
komendą python -m src.mcp.server (stdio) lub URL kontenera (http).
Struktura
src/
├── config.py # wszystkie env-zmienne + domyślne
├── main.py # CLI: build-index | interaktywne Q&A
├── assistant.py # CompanyKBAssistant (LLM decyduje czy wołać MCP-toolki)
├── catalog.py # offline-klasyfikacja dokumentów przez Ollama → JSON+HTML
├── ingest.py # multi-formatowy ingest: OCR skanów, vision-opis diagramów, Whisper-transkrypcja
├── rag/
│ ├── ingest.py # load_document (.txt/.md/.pdf/.docx)
│ ├── chunk.py # chunk_text (tiktoken cl100k_base, overlap)
│ ├── embed.py # embed_chunks (sentence-transformers)
│ ├── build_index.py # build_index → FAISS + pickle
│ └── query.py # retrieve / build_prompt / ask
└── mcp/
├── server.py # FastMCP: 5 MCP-toolków + 4 trasy REST
└── client.py # MCPClient (JSON-RPC przez subprocess)
Multi-formatowy ingest (OCR skanów przez Tesseract, opis rysunków/schematów przez model vision, transkrypcja audio/wideo przez Whisper) — osobna, cięższa pod względem zależności ścieżka, niepotrzebna dla podstawowego korpusu tekstowego powyżej.
Licencja
MIT — patrz LICENSE. © Fayna Digital.
推荐服务器
Baidu Map
百度地图核心API现已全面兼容MCP协议,是国内首家兼容MCP协议的地图服务商。
Playwright MCP Server
一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。
Magic Component Platform (MCP)
一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。
Audiense Insights MCP Server
通过模型上下文协议启用与 Audiense Insights 账户的交互,从而促进营销洞察和受众数据的提取和分析,包括人口统计信息、行为和影响者互动。
VeyraX
一个单一的 MCP 工具,连接你所有喜爱的工具:Gmail、日历以及其他 40 多个工具。
graphlit-mcp-server
模型上下文协议 (MCP) 服务器实现了 MCP 客户端与 Graphlit 服务之间的集成。 除了网络爬取之外,还可以将任何内容(从 Slack 到 Gmail 再到播客订阅源)导入到 Graphlit 项目中,然后从 MCP 客户端检索相关内容。
Kagi MCP Server
一个 MCP 服务器,集成了 Kagi 搜索功能和 Claude AI,使 Claude 能够在回答需要最新信息的问题时执行实时网络搜索。
e2b-mcp-server
使用 MCP 通过 e2b 运行代码。
Neon MCP Server
用于与 Neon 管理 API 和数据库交互的 MCP 服务器
Exa MCP Server
模型上下文协议(MCP)服务器允许像 Claude 这样的 AI 助手使用 Exa AI 搜索 API 进行网络搜索。这种设置允许 AI 模型以安全和受控的方式获取实时的网络信息。